The ItemCatalog JSON object defines catalog data for an item of the  Dsco system.

  • 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
  • Dsco reserves 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 and at some point won't contain a number

Attributes

Name Req Type Description
sku string The supplier-provided unique ID for the item whose catalog this object represents which will also be the unique ID of the corresponding ItemInventory object; this value must be provided and must be unique amongst all items for the given supplier who owns the item
productStatus
enum
  • pending
    The supplier is in the process of setting up the item within Dsco and it is not ready for its trading partners to sell it.  Dsco will not export this item in inventory update feeds to the supplier’s trading partners, but will export this item in catalog feeds.
  • active
    The supplier has completed item setup for this item and trading partners may now sell the item when the item has positive quantity.
  • discontinued_sell_through
    The supplier has discontinued the item but wants its trading partners to continue to sell the item until the item's availableQuantity goes to zero.  Dsco will continue to send inventory updates to the supplier’s trading partners if the supplier continues to update the available quantity of the item.  At some point, it is expected that the available quantity will go to zero and remain there.  However, if the supplier should send a positive inventory quantity, it will be passed to its trading partners.
  • discontinued
    The item is discontinued and the supplier’s trading partners are not to sell any more.  Dsco will export the item to the supplier’s trading partners via its designated inventory update feed (file/API/webhook), setting the item’s quantity to zero and overriding whatever value may be there.  Suppliers may continue to send positive inventory quantity values for the item to Dsco and Dsco will store it, however, Dsco will continue to send zero quantity available to the supplier’s trading partners.

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.  Supplier's 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
dscoProductId
string 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)
productGroup
string The name of the product group this item is associated with
productTitle
string The title of the product this item is associated with
dscoSupplierId
int Dsco's unique ID for the supplier that owns this item
dscoSupplierName
string Dsco's name for the supplier that owns this item
tradingPartnerId
string The partner's unique ID for the supplier that owns this item
tradingPartnerName
string The partner's name for the supplier that owns this item
dscoCreateDate
isodate The date this item was created
dscoLastUpdateDate
isodate The last date any attribute of the associated item was updated
dscoLastProductStatusUpdateDate
isodate The last time the product status was updated
title
string The item's title
description
string The item's description
shortDescription
string The item's short description
shortTextDescription
string The item's short text description
longTextDescription

string The item's long text description
details
string The item's details
currencyCode
string The item's currency code
brand
string The item's brand
commissionPercentage
float The item's commission percentage
commissionAmount
float The item's commission amount
productAvailabilityStartDate
isodate When the item will be available
productAvailabilityEndDate
isodate When the item will no longer be available
msrp
float The item's msrp
map
float The item's map
handlingCost
float The item's handling cost
sizePrimaryNrfCode
int NFR size code
sizePrimaryDescription
string NFR size description
sizeSecondaryNrfCode
int NFR size code
sizeSecondaryDescription
string NFR size description
colorPrimaryNrfCode
int NFR color code
colorPrimaryDescription
string NFR color description
colorSecondaryNrfCode
int NFR color code
colorSecondaryDescription
string NFR color description
colorTertiaryNrfCode
int NFR color code
colorTertiaryDescription
string NFR color description
hazmatFlag
boolean The item's hazmat flag
hazmatClassCode
string The item's hazmat class code
hazmatDescription
string The item's hazmat description
weight
float The item's weight
weightUnits
enum The item's weight unit, one of...
  • oz
  • g
  • lb
  • kg

length
float The item's length
width
float The item's width
height
float The item's height
dimensionUnits
enum The item's dimension unit, one of...
  • in
  • ft
  • m
  • cm
  • mm

packageWeight
float The item's package weight
packageWeightUnits
enum The package weight's unit, one of...
  • oz
  • g
  • lb
  • kg
packageLength

float The item's package length
packageHeight
float The item's package height
packageWidth
float The item's package width
packageDimensionUnits

enum The item's package dimension unit, one of...
  • in
  • ft
  • m
  • cm
  • mm
attributes
object[]
object.name
object.value
A list of arbitrary attributes associated with the item where each attribute object in the list has a required name and value
warranty
string The item's warranty
category
string The item's category
assortments
string[] The supplier assortments the item is a member of
countryOfOrigin
string The item's country of origin
postalCarrierServiceFlag

boolean
groundCarrierServiceFlag

boolean
airCarrierServiceFlag

boolean
freightCarrierServiceFlag

boolean
averagePostalCarrierServiceCost

float
averageGroundCarrierServiceCost

float
averageAirCarrierServiceCost

float
averageFreightCarrierServiceCost

float
shipsAloneFlag

boolean
maxShipSingleBox

int
productImages

object[]
object.name
object.reference
A list of product images where each object in the list has a required name and reference
images
object[]
object.name
object.reference
A list of item images where each object in the list has a required name and reference
swatchImageReference

string
brandLogoImageReference

string
condition
string
crossSellSkus
string
purchasedTogetherSkus

string
keywords

string
featuredSkuFlag

boolean
giftWrapAvailableFlag

boolean
persAvailableFlag

boolean
persNumLines

int
persCharPerLine

int
persDescription

string
persShipLeadTime

int
persShipLeadTimeType

string
manufactureCost

double

Example

{
    "sku": "asfs92342klsdfsf",
    "productStatus": "pending"
}
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.