Product Object
Field | Description | |
Data Type
Required? | Best Practice? | |
productId | The associated product. | |
TRUE |
| |
productName | The Supplier name for the product | |
TRUE |
| |
LocationDecorationArray | An array of Location Decoration objects | |
OBJECT ARRAY
TRUE |
| |
description | Basic product description or bulleted list of descriptions. | |
2048 STRING ARRAY
TRUE |
| |
priceExpiresDate | The date that the pricing in the ProductPriceGroupArray portion of the response expires. | |
ISO 8601 DATE
FALSE | Yes | |
ProductMarketingPointArray | Marketing points type and content. An array of MarketingPoint objects. | |
FALSE | Yes | |
ProductKeywordArray | Array of keywords often used in searching for this product. An array of ProductKeyword objects. | |
FALSE | Yes | |
productBrand | The specific product brand | |
FALSE | Yes | |
export | Product status for export | |
TRUE |
| |
ProductCategoryArray | The product’s categorization array. An array of ProductCategory objects. | |
OBJECT ARRAY
FALSE |
| |
RelatedProductArray | Products related to the quested product as Substitutable, CompanionSell, or Common Grouping (Family). An array of RelatedProduct objects. | |
OBJECT ARRAY
FALSE |
| |
ProductPartArray | All part specific product data. An array of ProductPart objects. | |
OBJECT ARRAY
TRUE |
| |
lastChangeDate | The date time stamp of the most recent change to this data in ISO 8601 format | |
ISO 8601 DATE
TRUE |
| |
creationDate | The date time stamp when this products data initially became available in ISO 8601 format | |
ISO 8601 DATE
TRUE |
| |
endDate | The Date this Product expires from Supplier availability in ISO 8601 format | |
FALSE |
| |
effectiveDate | The Date this Product initially becomes available from the Supplier in ISO 8601 format | |
FALSE |
| |
isCaution | Cautionary status to review for specific warnings about using product data. | |
NILLABLE BOOLEAN
TRUE |
| |
cautionComment | Product cautionary comments | |
FALSE |
| |
isCloseout | Indicates if the product is a closeout | |
NILLABLE BOOLEAN
TRUE |
| |
lineName | Line Name / Division to which this product belongs | |
64 STRING
FALSE | Yes | |
primaryImageURL | The URL of the product’s primary image. Any valid URL can be returned including prefixes like http and ftp. | |
1024 STRING
FALSE |
| |
ProductPriceGroupArray | Marketing-oriented pricing information. Represented as an array of Product Price objects. Prices are List prices. | |
OBJECT ARRAY
FALSE |
| |
complianceInfoAvailable | Indicates if there is information about this product via the Product Safety & Compliance service. | |
NILLABLE BOOLEAN
FALSE |
| |
unspscCommodityCode | The United Nations Standard Products and Services Code® (UNSPSC®) that best describes this product. Note that the enumerated values are the UNSPSC "Commodity" codes. For more information, refer to https://www.unspsc.org . | |
FALSE |
| |
imprintSize | The imprint Size | |
FALSE | Yes | |
defaultSetUpCharge | The default setup charge for this product. Can be a textual description. | |
STRING 1024
FALSE | Yes | |
defaultRunCharge | The default RUN charge for this product. Can be a textual description. | |
STRING 1024
FALSE |
| |
FobPointArray | An array of FOB points object | |
TRUE |
|
Location Decoration
Field | Description | Data Type | Required? | Best Practice? |
locationName | Location name | 255 STRING | TRUE |
|
maxImprintColors | The maximum number of imprint colors available, based on a decoration location and type. | INTEGER | FALSE | Yes |
decorationName | Decoration name | 64 STRING | TRUE |
|
locationDecorationComboDefault | Is this the default location | BOOLEAN | TRUE |
|
priceIncludes | Does this include price | BOOLEAN | TRUE |
|
Product Part Object
Field | Description | Data Type | Required? | Best Practice? |
partId | The part Id | 64 STRING | TRUE |
|
description | Description | 2048 STRING | FALSE |
|
countryOfOrigin | Country of Origin | 2 STRING | FALSE |
|
ColorArray | Information about the part colors | OBJECT ARRAY | FALSE | Yes |
primaryMaterial | Primary material of construction | 64 STRING | FALSE |
|
SpecificationArray | Specifications | OBJECT ARRAY | FALSE |
|
shape | General shape | 64 STRING | FALSE |
|
ApparelSize | Used to describe an apparel size | OBJECT | FALSE |
|
Dimension | Physical dimensions and weight | OBJECT | FALSE |
|
leadTime | Lead time in days | INT | FALSE | Yes |
unspsc | United Nations Standard Products and Services Code (UNSPSC) | 8 STRING | FALSE |
|
gtin | Global Trade Item Number (GTIN) | 14 STRING | FALSE | Yes |
isRushService | Rush service | NILLABLE BOOLEAN | TRUE |
|
ShippingPackageAgive rray | Shipping package option details for the partPackaging Default package type; e.g. Carton, Box, Pallet. An array of ShippingPackage objects. | OBJECT ARRAY | FALSE |
|
ProductPackagingArray | Packaging option details; e.g. Gift Box, Cello Pack, Sleeve. An array of ProductPackaging objects. | OBJECT ARRAY | FALSE | Yes |
endDate | The date this part expires from supplier availability in ISO 8601 format | ISO 8601 DATE | FALSE |
|
effectiveDate | The Date this Part initially becomes available from the Supplier in ISO 8601 format | ISO 8601 DATE | FALSE |
|
isCloseout | Indicates if a closeout | NILLABLE BOOLEAN | TRUE |
|
isCaution | Cautionary status to review for specific warnings about using product data | NILLABLE BOOLEAN | TRUE |
|
cautionComment | Cautionary comments | 1024 STRING | FALSE |
|
nmfcCode | National Motor Freight Classification Code | DECIMAL | FALSE |
|
nmfcDescription | National Motor Freight Classification Description | 1024 STRING | FALSE |
|
nmfcNumber | National Motor Freight Classification Number | 64 STRING | FALSE |
|
isOnDemand | Manufactured on demand / Made to order | NILLABLE | TRUE |
|
isHazmat | Contains hazardous material. A nil value indicates this it is unknown or the data is not available by the supplier. | NILLABLE | TRUE |
|
primaryColor | The "go to market" color. Represented as a Color Object. | OBJECT | FALSE |
|
Color Object
Field | Description | Data Type | Required? | Best Practice? |
colorName | Supplier specific color name. Go to market color | 64 STRING | TRUE |
|
hex | The HEX code representation. This is not a supplement for product color but data used for generating web user interfaces. | 64 STRING | FALSE |
|
approximatePms | The PMS code representation. This is not a supplement for product color. | 64 STRING | FALSE | Yes |
standardColorName | The standard color that best describes this color. Eventually may become an enumeration. | 64 STRING | FALSE | Yes |
Product Price Group Object
Field | Description | Data Type | Required? | Best Practice? |
groupName | Price group description | 64 STRING | TRUE |
|
currency | The currency supported in ISO4217 format. | 64 STRING | TRUE |
|
description | The description of the product price | 2028 STRING | FALSE | Yes |
ProductPriceArray | An array of Product Price objects | ARRAY | TRUE |
|
Product Price Object
Field | Description | Data Type | Required? | Best Practice? |
quantityMax | The maximum quantity for which this price applies. | INT | TRUE |
|
quantityMin | The minimum quantity for which this price applies. | INT | TRUE |
|
price | The price value. | DECIMAL | TRUE |
|
discountCode | The discount code. | 5 STRING | FALSE | Yes |
Product Packaging Object
Field | Description | Data Type | Required? | Best Practice? |
default | Boolean flag identifying the single default packaging for this package | BOOLEAN | TRUE |
|
packageType | The packaging specific type for this partId e.g. Gift Box, Cello Pack, Sleeve | 256 STRING | TRUE |
|
description | The Packaging specific description | 2048 STRING | FALSE | Yes |
quantity | The partId unit Quantity included within this specific Packaging Option | DECIMAL | TRUE |
|
dimensionUom | The unit of measure for the package | 2 STRING FACIT | TRUE |
|
depth | The depth/length of the package in the dimensionUom unit of measure | DECIMAL | FALSE | Yes |
height | The height of the package in the dimensionUom unit of measure | DECIMAL | FALSE | Yes |
width | The width of the package in the dimensionUom unit of measure | DECIMAL | FALSE | Yes |
weightUom | The weight unit of measure for the packageType | 2 STRING FACIT | TRUE |
|
weight | The weight of the specific packageType | DECIMAL | FALSE | Yes |
Shipping Package Object
Field | Description | Data Type | Required? | Best Practice? |
packageType | The shipping package specific type for this shipping package e.g. Box, Carton, etc. | 256 STRING | TRUE |
|
description | The shipping package specific description | 2048 STRING | FALSE | Yes |
quantity | The partId unit quantity included within this specific shipping packaging option | DECIMAL | TRUE |
|
dimensionUom | The weight unit of measure for the packageType | 2 STRING FACIT | TRUE |
|
depth | The depth/length of the shipping package in the dimensionUom unit of measure | DECIMAL | FALSE | Yes |
height | The height of the shipping package in the dimensionUom unit of measure | DECIMAL | FALSE | Yes |
width | The width of the shipping package in the dimensionUom unit of measure | DECIMAL | FALSE | Yes |
weightUom | The weight unit of measure for the packageType | 2 FACIT STRING | TRUE |
|
weight | The weight of the specific packageType | DECIMAL | FALSE | Yes |