GET v1/Products/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Common.Dto.Get.Product

Name	Type	Additional information
code	string	Required String length: inclusive between 0 and 1000
name	string	Required String length: inclusive between 0 and 100
description	string	String length: inclusive between 0 and 1000
productType	string	Required
status	string	None.
taxExempt	boolean	None.
orderToCashCycle	Common.Dto.Get.OrderToCashCycle	None.
availableForPurchase	boolean	None.
isTrackingItems	boolean	None.
quantity	decimal number	Range: inclusive between 0 and 2147483647
avalaraItemCode	string	String length: inclusive between 0 and 50
avalaraTaxCode	string	String length: inclusive between 0 and 25
glCode	string	None.
glCodeName	string	None.
productCustomFields	Collection of Common.Dto.Get.ProductCustomField	None.
deletable	boolean	None.
salesforceId	string	None.
netsuiteItemId	string	None.
digitalRiverCountryOfOrigin	integer	None.
digitalRiverTaxCode	integer	None.
digitalRiverECCN	integer	None.
pushedToDigitalRiver	boolean	None.
quickBooksItemId	integer	None.
quickBooksRecordType	string	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "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"
            }
          ],
          "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"
            }
          ],
          "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"
          }
        ]
      },
      {
        "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"
          }
        ]
      }
    ],
    "amounts": [
      {
        "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": {}
    }
  ],
  "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"
}