The ItemInventory JSON object defines inventory data for an item of the CommerceHub Dsco platform.

  • isodate fields use one of these ISO 8601 formats: 2014-01-01T10:30:00.000+01:00, 2014-01-01T10:30:00.000+0100, 2014-01-01T10:30:00.000Z
  • We reserve the right to add new attributes at any time, so partners should ensure their validators won't break should this happen.

V3 versus V2 Differences

  • dscoItemId
    In V2, this attribute was an auto-incrementing integer. In V3, this attribute is now a string. At some point, it won't contain a number.
  • dscoProductId
    In V2, this attribute was an auto-incrementing integer. In V3, this attribute is now a string. At some point, it won't contain a number.
  • Dsco removed catalog-specific attributes from this object to ensure a clean separation between inventory and catalog data. The following attributes were removed:
    • title
    • productStatus

Attributes

Name Req Type Description
sku string The supplier-provided unique ID for the item whose inventory this object represents. This value must be provided and must be unique among all items for the given supplier who owns the item.
warehouses

ItemWarehouse[]
Quantity must be provided within these objects for this item where each item represents the quantity at a specific warehouse. Only one warehouse object must be present.
dscoItemId
string Dsco's unique ID for this item.
upc
string Optional unique ID for this item.
ean
string Optional unique ID for this item.
mpn
string Optional unique ID for this item.
isbn
string Optional unique ID for this item.
gtin
string Optional unique ID for this item.
partnerSku
string

This value will not be set when used by a supplier. Suppliers specify the partnerSkuMap. For retailers, this will be the retailer-specific value provided by the supplier in the partnerSkuMap attribute.

partnerSkuMap
PartnerSkuMap[] This contains a list of partner-specific sku values and the partner that provided the value.
brand
string The name of the brand.
quantityAvailable
int If the partner so designates, this will be the sum of all quantity at all warehouses for this item. This value is read-only as Dsco requires quantity to be specified at the warehouse level (see warehouses attribute below).
cost
float The cost of the item.
status
enum This value is read-only and is derived from the quantityAvailable attribute and the associated item's catalog.productStatus.

  • in-stock
    This state indicates that the item is in-stock, and the quantityAvailable value should be greater than zero.
  • out-of-stock
    This state indicates that the item is out-of-stock, and the quantityAvailable value should be zero but it may change in the future.
  • discontinued
    This state indicates that the item is discontinued. Please reference the associated item's productStatus attribute which may drive changing this value and, if productStatus is used, may allow retailers to continue to sell the item even after the item is considered discontinued (productStatus discontinued_sell_through status).


estimatedAvailabilityDate

isodate The estimated availability date for the item inventory.
quantityOnOrder
int The quantity on order for the item.
currencyCode
string The currency code of the cost.
dscoSupplierId

Dsco's unique ID for the supplier that owns this item.
dscoSupplierName

Dsco's name for the supplier that owns this item.
tradingPartnerId

The partner's unique ID for the supplier that owns this item.
tradingPartnerName

The partner's name for the supplier that owns this item.
dscoCreateDate

The date this item was created.
dscoLastQuantityUpdateDate

The date of the last quantity update.
dscoLastCostUpdateDate

The date of the last cost update.
dscoLastUpdateDate

The last date any attribute of the associated item was updated.

Example

{
    "sku": "asfs92342klsdfsf",
    "warehouses": [{"code":"wh2", "quantity":22}]
}
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.