GET v1/Products/{id}

Documentation for 'Get'.

Request Information

Parameters

NameDescriptionAdditional information
id
Documentation for 'id'.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify!
{
  "code": "sample string 1",
  "name": "sample string 2",
  "description": "sample string 3",
  "productType": "sample string 4",
  "status": "sample string 5",
  "taxExempt": true,
  "orderToCashCycle": {
    "earningInterval": "sample string 1",
    "earningNumberOfIntervals": 1,
    "earningTimingInterval": "sample string 2",
    "earningTimingType": "sample string 3",
    "pricingModel": {
      "pricingModelType": "sample string 1",
      "quantityRanges": [
        {
          "min": 1.0,
          "max": 1.0,
          "prices": [
            {
              "amount": 1.0,
              "conditionAmount": 1.0,
              "variableAmount": 1.0,
              "currency": "sample string 1",
              "conditionAmountDays": 1,
              "id": 2,
              "uri": "sample string 3"
            },
            {
              "amount": 1.0,
              "conditionAmount": 1.0,
              "variableAmount": 1.0,
              "currency": "sample string 1",
              "conditionAmountDays": 1,
              "id": 2,
              "uri": "sample string 3"
            },
            {
              "amount": 1.0,
              "conditionAmount": 1.0,
              "variableAmount": 1.0,
              "currency": "sample string 1",
              "conditionAmountDays": 1,
              "id": 2,
              "uri": "sample string 3"
            }
          ],
          "id": 2,
          "uri": "sample string 3"
        },
        {
          "min": 1.0,
          "max": 1.0,
          "prices": [
            {
              "amount": 1.0,
              "conditionAmount": 1.0,
              "variableAmount": 1.0,
              "currency": "sample string 1",
              "conditionAmountDays": 1,
              "id": 2,
              "uri": "sample string 3"
            },
            {
              "amount": 1.0,
              "conditionAmount": 1.0,
              "variableAmount": 1.0,
              "currency": "sample string 1",
              "conditionAmountDays": 1,
              "id": 2,
              "uri": "sample string 3"
            },
            {
              "amount": 1.0,
              "conditionAmount": 1.0,
              "variableAmount": 1.0,
              "currency": "sample string 1",
              "conditionAmountDays": 1,
              "id": 2,
              "uri": "sample string 3"
            }
          ],
          "id": 2,
          "uri": "sample string 3"
        },
        {
          "min": 1.0,
          "max": 1.0,
          "prices": [
            {
              "amount": 1.0,
              "conditionAmount": 1.0,
              "variableAmount": 1.0,
              "currency": "sample string 1",
              "conditionAmountDays": 1,
              "id": 2,
              "uri": "sample string 3"
            },
            {
              "amount": 1.0,
              "conditionAmount": 1.0,
              "variableAmount": 1.0,
              "currency": "sample string 1",
              "conditionAmountDays": 1,
              "id": 2,
              "uri": "sample string 3"
            },
            {
              "amount": 1.0,
              "conditionAmount": 1.0,
              "variableAmount": 1.0,
              "currency": "sample string 1",
              "conditionAmountDays": 1,
              "id": 2,
              "uri": "sample string 3"
            }
          ],
          "id": 2,
          "uri": "sample string 3"
        }
      ],
      "pricingFormulaType": "sample string 2",
      "id": 3,
      "uri": "sample string 4"
    },
    "earningSchedules": [
      {
        "currency": "sample string 1",
        "schedules": [
          {
            "scheduledInterval": "sample string 1",
            "numberOfIntervals": 1,
            "scheduledAmount": 1.0,
            "reference": "sample string 2",
            "scheduledType": "sample string 3",
            "id": 4,
            "uri": "sample string 5"
          },
          {
            "scheduledInterval": "sample string 1",
            "numberOfIntervals": 1,
            "scheduledAmount": 1.0,
            "reference": "sample string 2",
            "scheduledType": "sample string 3",
            "id": 4,
            "uri": "sample string 5"
          },
          {
            "scheduledInterval": "sample string 1",
            "numberOfIntervals": 1,
            "scheduledAmount": 1.0,
            "reference": "sample string 2",
            "scheduledType": "sample string 3",
            "id": 4,
            "uri": "sample string 5"
          }
        ]
      },
      {
        "currency": "sample string 1",
        "schedules": [
          {
            "scheduledInterval": "sample string 1",
            "numberOfIntervals": 1,
            "scheduledAmount": 1.0,
            "reference": "sample string 2",
            "scheduledType": "sample string 3",
            "id": 4,
            "uri": "sample string 5"
          },
          {
            "scheduledInterval": "sample string 1",
            "numberOfIntervals": 1,
            "scheduledAmount": 1.0,
            "reference": "sample string 2",
            "scheduledType": "sample string 3",
            "id": 4,
            "uri": "sample string 5"
          },
          {
            "scheduledInterval": "sample string 1",
            "numberOfIntervals": 1,
            "scheduledAmount": 1.0,
            "reference": "sample string 2",
            "scheduledType": "sample string 3",
            "id": 4,
            "uri": "sample string 5"
          }
        ]
      },
      {
        "currency": "sample string 1",
        "schedules": [
          {
            "scheduledInterval": "sample string 1",
            "numberOfIntervals": 1,
            "scheduledAmount": 1.0,
            "reference": "sample string 2",
            "scheduledType": "sample string 3",
            "id": 4,
            "uri": "sample string 5"
          },
          {
            "scheduledInterval": "sample string 1",
            "numberOfIntervals": 1,
            "scheduledAmount": 1.0,
            "reference": "sample string 2",
            "scheduledType": "sample string 3",
            "id": 4,
            "uri": "sample string 5"
          },
          {
            "scheduledInterval": "sample string 1",
            "numberOfIntervals": 1,
            "scheduledAmount": 1.0,
            "reference": "sample string 2",
            "scheduledType": "sample string 3",
            "id": 4,
            "uri": "sample string 5"
          }
        ]
      }
    ],
    "amounts": [
      {
        "currency": "sample string 1",
        "amount": 2.0
      },
      {
        "currency": "sample string 1",
        "amount": 2.0
      },
      {
        "currency": "sample string 1",
        "amount": 2.0
      }
    ],
    "id": 4,
    "uri": "sample string 5"
  },
  "availableForPurchase": true,
  "isTrackingItems": true,
  "quantity": 1.0,
  "avalaraItemCode": "sample string 9",
  "avalaraTaxCode": "sample string 10",
  "glCode": "sample string 11",
  "glCodeName": "sample string 12",
  "productCustomFields": [
    {
      "id": 1,
      "customFieldId": 1,
      "key": "sample string 1",
      "friendlyName": "sample string 2",
      "dataType": "sample string 3",
      "defaultValue": {}
    },
    {
      "id": 1,
      "customFieldId": 1,
      "key": "sample string 1",
      "friendlyName": "sample string 2",
      "dataType": "sample string 3",
      "defaultValue": {}
    },
    {
      "id": 1,
      "customFieldId": 1,
      "key": "sample string 1",
      "friendlyName": "sample string 2",
      "dataType": "sample string 3",
      "defaultValue": {}
    }
  ],
  "deletable": true,
  "salesforceId": "sample string 14",
  "netsuiteItemId": "sample string 15",
  "digitalRiverCountryOfOrigin": 1,
  "digitalRiverTaxCode": 1,
  "digitalRiverECCN": 1,
  "pushedToDigitalRiver": true,
  "quickBooksItemId": 1,
  "quickBooksRecordType": "sample string 16",
  "id": 17,
  "uri": "sample string 18"
}

application/xml, text/xml

Sample:
Click to beautify!
<Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
  <Id>17</Id>
  <Uri>sample string 18</Uri>
  <AvailableForPurchase>true</AvailableForPurchase>
  <AvalaraItemCode>sample string 9</AvalaraItemCode>
  <AvalaraTaxCode>sample string 10</AvalaraTaxCode>
  <Code>sample string 1</Code>
  <Deletable>true</Deletable>
  <Description>sample string 3</Description>
  <DigitalRiverCountryOfOriginId>1</DigitalRiverCountryOfOriginId>
  <DigitalRiverECCNId>1</DigitalRiverECCNId>
  <DigitalRiverTaxCodeId>1</DigitalRiverTaxCodeId>
  <GLCode>sample string 11</GLCode>
  <GLCodeName>sample string 12</GLCodeName>
  <IsTrackingItems>true</IsTrackingItems>
  <Name>sample string 2</Name>
  <NetsuiteItemId>sample string 15</NetsuiteItemId>
  <OrderToCashCycle>
    <Id>4</Id>
    <Uri>sample string 5</Uri>
    <Amounts>
      <CurrencyAmount>
        <Amount>2</Amount>
        <Currency>sample string 1</Currency>
      </CurrencyAmount>
      <CurrencyAmount>
        <Amount>2</Amount>
        <Currency>sample string 1</Currency>
      </CurrencyAmount>
      <CurrencyAmount>
        <Amount>2</Amount>
        <Currency>sample string 1</Currency>
      </CurrencyAmount>
    </Amounts>
    <EarningInterval>sample string 1</EarningInterval>
    <EarningNumberOfIntervals>1</EarningNumberOfIntervals>
    <EarningSchedules>
      <CurrencyEarningSchedules>
        <Currency>sample string 1</Currency>
        <Schedules>
          <IntervalEarningSchedule>
            <Id>4</Id>
            <Uri>sample string 5</Uri>
            <NumberOfIntervals>1</NumberOfIntervals>
            <Reference>sample string 2</Reference>
            <ScheduledAmount>1</ScheduledAmount>
            <ScheduledInterval>sample string 1</ScheduledInterval>
            <ScheduledType>sample string 3</ScheduledType>
          </IntervalEarningSchedule>
          <IntervalEarningSchedule>
            <Id>4</Id>
            <Uri>sample string 5</Uri>
            <NumberOfIntervals>1</NumberOfIntervals>
            <Reference>sample string 2</Reference>
            <ScheduledAmount>1</ScheduledAmount>
            <ScheduledInterval>sample string 1</ScheduledInterval>
            <ScheduledType>sample string 3</ScheduledType>
          </IntervalEarningSchedule>
          <IntervalEarningSchedule>
            <Id>4</Id>
            <Uri>sample string 5</Uri>
            <NumberOfIntervals>1</NumberOfIntervals>
            <Reference>sample string 2</Reference>
            <ScheduledAmount>1</ScheduledAmount>
            <ScheduledInterval>sample string 1</ScheduledInterval>
            <ScheduledType>sample string 3</ScheduledType>
          </IntervalEarningSchedule>
        </Schedules>
      </CurrencyEarningSchedules>
      <CurrencyEarningSchedules>
        <Currency>sample string 1</Currency>
        <Schedules>
          <IntervalEarningSchedule>
            <Id>4</Id>
            <Uri>sample string 5</Uri>
            <NumberOfIntervals>1</NumberOfIntervals>
            <Reference>sample string 2</Reference>
            <ScheduledAmount>1</ScheduledAmount>
            <ScheduledInterval>sample string 1</ScheduledInterval>
            <ScheduledType>sample string 3</ScheduledType>
          </IntervalEarningSchedule>
          <IntervalEarningSchedule>
            <Id>4</Id>
            <Uri>sample string 5</Uri>
            <NumberOfIntervals>1</NumberOfIntervals>
            <Reference>sample string 2</Reference>
            <ScheduledAmount>1</ScheduledAmount>
            <ScheduledInterval>sample string 1</ScheduledInterval>
            <ScheduledType>sample string 3</ScheduledType>
          </IntervalEarningSchedule>
          <IntervalEarningSchedule>
            <Id>4</Id>
            <Uri>sample string 5</Uri>
            <NumberOfIntervals>1</NumberOfIntervals>
            <Reference>sample string 2</Reference>
            <ScheduledAmount>1</ScheduledAmount>
            <ScheduledInterval>sample string 1</ScheduledInterval>
            <ScheduledType>sample string 3</ScheduledType>
          </IntervalEarningSchedule>
        </Schedules>
      </CurrencyEarningSchedules>
      <CurrencyEarningSchedules>
        <Currency>sample string 1</Currency>
        <Schedules>
          <IntervalEarningSchedule>
            <Id>4</Id>
            <Uri>sample string 5</Uri>
            <NumberOfIntervals>1</NumberOfIntervals>
            <Reference>sample string 2</Reference>
            <ScheduledAmount>1</ScheduledAmount>
            <ScheduledInterval>sample string 1</ScheduledInterval>
            <ScheduledType>sample string 3</ScheduledType>
          </IntervalEarningSchedule>
          <IntervalEarningSchedule>
            <Id>4</Id>
            <Uri>sample string 5</Uri>
            <NumberOfIntervals>1</NumberOfIntervals>
            <Reference>sample string 2</Reference>
            <ScheduledAmount>1</ScheduledAmount>
            <ScheduledInterval>sample string 1</ScheduledInterval>
            <ScheduledType>sample string 3</ScheduledType>
          </IntervalEarningSchedule>
          <IntervalEarningSchedule>
            <Id>4</Id>
            <Uri>sample string 5</Uri>
            <NumberOfIntervals>1</NumberOfIntervals>
            <Reference>sample string 2</Reference>
            <ScheduledAmount>1</ScheduledAmount>
            <ScheduledInterval>sample string 1</ScheduledInterval>
            <ScheduledType>sample string 3</ScheduledType>
          </IntervalEarningSchedule>
        </Schedules>
      </CurrencyEarningSchedules>
    </EarningSchedules>
    <EarningTimingInterval>sample string 2</EarningTimingInterval>
    <EarningTimingType>sample string 3</EarningTimingType>
    <PricingModel>
      <Id>3</Id>
      <Uri>sample string 4</Uri>
      <PricingFormulaType>sample string 2</PricingFormulaType>
      <PricingModelType>sample string 1</PricingModelType>
      <QuantityRanges>
        <QuantityRange>
          <Id>2</Id>
          <Uri>sample string 3</Uri>
          <Max>1</Max>
          <Min>1</Min>
          <Prices>
            <Price>
              <Id>2</Id>
              <Uri>sample string 3</Uri>
              <Amount>1</Amount>
              <ConditionAmount>1</ConditionAmount>
              <ConditionAmountDays>1</ConditionAmountDays>
              <Currency>sample string 1</Currency>
              <VariableAmount>1</VariableAmount>
            </Price>
            <Price>
              <Id>2</Id>
              <Uri>sample string 3</Uri>
              <Amount>1</Amount>
              <ConditionAmount>1</ConditionAmount>
              <ConditionAmountDays>1</ConditionAmountDays>
              <Currency>sample string 1</Currency>
              <VariableAmount>1</VariableAmount>
            </Price>
            <Price>
              <Id>2</Id>
              <Uri>sample string 3</Uri>
              <Amount>1</Amount>
              <ConditionAmount>1</ConditionAmount>
              <ConditionAmountDays>1</ConditionAmountDays>
              <Currency>sample string 1</Currency>
              <VariableAmount>1</VariableAmount>
            </Price>
          </Prices>
        </QuantityRange>
        <QuantityRange>
          <Id>2</Id>
          <Uri>sample string 3</Uri>
          <Max>1</Max>
          <Min>1</Min>
          <Prices>
            <Price>
              <Id>2</Id>
              <Uri>sample string 3</Uri>
              <Amount>1</Amount>
              <ConditionAmount>1</ConditionAmount>
              <ConditionAmountDays>1</ConditionAmountDays>
              <Currency>sample string 1</Currency>
              <VariableAmount>1</VariableAmount>
            </Price>
            <Price>
              <Id>2</Id>
              <Uri>sample string 3</Uri>
              <Amount>1</Amount>
              <ConditionAmount>1</ConditionAmount>
              <ConditionAmountDays>1</ConditionAmountDays>
              <Currency>sample string 1</Currency>
              <VariableAmount>1</VariableAmount>
            </Price>
            <Price>
              <Id>2</Id>
              <Uri>sample string 3</Uri>
              <Amount>1</Amount>
              <ConditionAmount>1</ConditionAmount>
              <ConditionAmountDays>1</ConditionAmountDays>
              <Currency>sample string 1</Currency>
              <VariableAmount>1</VariableAmount>
            </Price>
          </Prices>
        </QuantityRange>
        <QuantityRange>
          <Id>2</Id>
          <Uri>sample string 3</Uri>
          <Max>1</Max>
          <Min>1</Min>
          <Prices>
            <Price>
              <Id>2</Id>
              <Uri>sample string 3</Uri>
              <Amount>1</Amount>
              <ConditionAmount>1</ConditionAmount>
              <ConditionAmountDays>1</ConditionAmountDays>
              <Currency>sample string 1</Currency>
              <VariableAmount>1</VariableAmount>
            </Price>
            <Price>
              <Id>2</Id>
              <Uri>sample string 3</Uri>
              <Amount>1</Amount>
              <ConditionAmount>1</ConditionAmount>
              <ConditionAmountDays>1</ConditionAmountDays>
              <Currency>sample string 1</Currency>
              <VariableAmount>1</VariableAmount>
            </Price>
            <Price>
              <Id>2</Id>
              <Uri>sample string 3</Uri>
              <Amount>1</Amount>
              <ConditionAmount>1</ConditionAmount>
              <ConditionAmountDays>1</ConditionAmountDays>
              <Currency>sample string 1</Currency>
              <VariableAmount>1</VariableAmount>
            </Price>
          </Prices>
        </QuantityRange>
      </QuantityRanges>
    </PricingModel>
  </OrderToCashCycle>
  <ProductCustomFields>
    <ProductCustomField>
      <DataType>sample string 3</DataType>
      <DefaultValue />
      <FriendlyName>sample string 2</FriendlyName>
      <Key>sample string 1</Key>
      <CustomFieldId>1</CustomFieldId>
      <Id>1</Id>
    </ProductCustomField>
    <ProductCustomField>
      <DataType>sample string 3</DataType>
      <DefaultValue />
      <FriendlyName>sample string 2</FriendlyName>
      <Key>sample string 1</Key>
      <CustomFieldId>1</CustomFieldId>
      <Id>1</Id>
    </ProductCustomField>
    <ProductCustomField>
      <DataType>sample string 3</DataType>
      <DefaultValue />
      <FriendlyName>sample string 2</FriendlyName>
      <Key>sample string 1</Key>
      <CustomFieldId>1</CustomFieldId>
      <Id>1</Id>
    </ProductCustomField>
  </ProductCustomFields>
  <ProductType>sample string 4</ProductType>
  <PushedToDigitalRiver>true</PushedToDigitalRiver>
  <Quantity>1</Quantity>
  <QuickBooksItemId>1</QuickBooksItemId>
  <QuickBooksRecordType>sample string 16</QuickBooksRecordType>
  <SalesforceId>sample string 14</SalesforceId>
  <Status>sample string 5</Status>
  <TaxExempt>true</TaxExempt>
</Product>