...
Field | Field Type | Description | Comments | ||
---|---|---|---|---|---|
itemId | string | Item ID |
| ||
allowBackorder | boolean | True if this item can be back ordered |
| ||
attributes | ItemAttribute[ ] | Array of Attributes on the item |
| ||
autoOrderable | boolean | True if the item can be auto ordered, false otherwise, see schedules property for the auto order schedules if this is true | Added June 2015, available to REST API only. | ||
availableQuantity | integer | The quantity of this item in stock and available for immediate shipment |
| ||
baseCurrencyCode | string | The default currency code of the merchant. | |||
cost costLocalized costLocalizedFormatted | number number string | Cost | local currency fields are only availabe in REST API. | ||
currencyCode | string | The currency code of the current shopping cart. | |||
defaultImageSsl | string | The full url for the item's default image using SSL protocol (will likely be // instead of https://) | Added Jan 2014, available to REST API only. | ||
defaultImageUrl | string | The full url for the item's default image. | Added June 2011, available to versions 1.1+ | ||
defaultThumbnailSsl | string | The full url for the item's default thumbnail using SSL protocol (will likely be // instead of https://)
| Added Jan 2014, available to REST API only. | ||
defaultThumbnailUrl | string | The full url for the item's default thumbnail.
| Added June 2011, available to versions 1.1+ | ||
description | string | Description |
| ||
extendedDescription | string | Extended description |
| ||
height | Distance | Height |
| ||
inactive | boolean | true if the item is inactive | Added Dec 2013, available to REST API only. | ||
inStock | boolean | True if this item is instock |
| ||
inventoryTracked | boolean | True if this item is tracking inventory levels |
| ||
itemOid | integer | Unique item object identifier. Provided to make debugging easier by UltraCart premium support. You probably won't ever use this in a meaningful way. |
| ||
length | Distance | Length |
| ||
manufacturerSuggestedRetailPrice manufacturerSuggestedRetailPriceLocalized manufacturerSuggestedRetailPriceLocalizedFormatted | number number string | The MSRP of the item. | local currency fields are only availabe in REST API . | ||
maximumQuantiy | number | The maximum quantity the customer can purchase. |
| ||
minimumQuantity | number | The minimum quantity the customer must purchase. |
| ||
multimedias | ItemMultimedia[ ] | Array of Multimedia on the item |
| ||
options | ItemOption[ ] | The options that are available on this item. |
| ||
preorder | boolean | True if this item is on pre-order |
| ||
schedules | String[] | If autoOrderable is true, this will contain an array of the different re-ship frequencies. | Added June 2015, available to REST API only. | ||
variations | ItemVariation[ ] | Array of Variations on the item | Added June 2011, available to versions 2.0.9+ | ||
weight | Weight | Weight |
| ||
width | Distance | Width |
|