Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 name64 STRING

TRUE

 

locationDecorationComboDefault

Is this the default location

BOOLEAN

TRUE

 

priceIncludes

Does this include price

BOOLEAN

TRUE

 

Product Part Object

Field

DescriptionData Type

Required?

Best Practice?

partId

The part Id64 STRING

TRUE

 

description

Description2048 STRINGARRAY

FALSE

 

countryOfOrigin

Country of Origin
ISO 3166-1 Alpha 2 code for Country
Example: CA=Canada;
US=United States2 STRING

FALSE

 

ColorArray

Information about the part colorsOBJECT ARRAY

FALSE

Yes

primaryMaterial

Primary material of construction64 STRING

FALSE

 

SpecificationArray

SpecificationsOBJECT ARRAY

FALSE

 

shape

General shape64 STRING

FALSE

 

ApparelSize

Used to describe an apparel sizeOBJECT

FALSE

 

Dimension

Physical dimensions and weightOBJECT

FALSE

 

leadTime

Lead time in daysINT

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 serviceNILLABLE 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 formatISO 8601 DATE

FALSE

 

effectiveDate

The Date this Part initially becomes available from the Supplier in ISO 8601 formatISO 8601 DATE

FALSE

 

isCloseout

Indicates if a closeoutNILLABLE BOOLEAN

TRUE

 

isCaution

Cautionary status to review for specific warnings about using product dataNILLABLE BOOLEAN

TRUE

 

cautionComment

Cautionary comments1024 STRING

FALSE

 

nmfcCode

National Motor Freight Classification CodeDECIMAL

FALSE

 

nmfcDescription

National Motor Freight Classification Description1024 STRING

FALSE

 

nmfcNumber

National Motor Freight Classification Number64 STRING

FALSE

 

isOnDemand

Manufactured on demand / Made to orderNILLABLE
BOOLEAN

TRUE

 

isHazmat

Contains hazardous material. A nil value indicates this it is unknown or the data is not available by the supplier.NILLABLE
BOOLEAN

TRUE

 

primaryColor

The "go to market" color. Represented as a Color Object.OBJECT

FALSE

 

Color Object

Field

DescriptionData 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

DescriptionData Type

Required?

Best Practice?

groupName

Price group description64 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 objectsARRAY

TRUE

 

Product Price Object

Field

DescriptionData 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

DescriptionData Type

Required?

Best Practice?

default

Boolean flag identifying the single default packaging for this packageBOOLEAN

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 OptionDECIMAL

TRUE

 

dimensionUom

The unit of measure for the package2 STRING FACIT

TRUE

 

depth

The depth/length of the package in the dimensionUom unit of measureDECIMAL

FALSE

Yes

height

The height of the package in the dimensionUom unit of measureDECIMAL

FALSE

Yes

width

The width of the package in the dimensionUom unit of measureDECIMAL

FALSE

Yes

weightUom

The weight unit of measure for the packageType2 STRING FACIT

TRUE

 

weight

The weight of the specific packageTypeDECIMAL

FALSE

Yes

Shipping Package Object

Field

DescriptionData 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 description2048 STRING

FALSE

Yes

quantity

The partId unit quantity included within this specific shipping packaging optionDECIMAL

TRUE

 

dimensionUom

The weight unit of measure for the packageType2 STRING FACIT

TRUE

 

depth

The depth/length of the shipping package in the dimensionUom unit of measureDECIMAL

FALSE

Yes

height

The height of the shipping package in the dimensionUom unit of measureDECIMAL

FALSE

Yes

width

The width of the shipping package in the dimensionUom unit of measureDECIMAL

FALSE

Yes

weightUom

The weight unit of measure for the packageType2 FACIT STRING

TRUE

 

weight

The weight of the specific packageTypeDECIMAL

FALSE

Yes