Product - JSON Specification

Summary

Use this format to send or receive product master data
NameDescription
RootThe top level document
Product

A product is a representation of a physical item.

Depending on which identifying fields are included in the specification, a product may represent a group of similar items like a style or an individual stock keeping unit.

If you include......the product represents......representing
only product_ida styleiPhone 11 Pro Max or Air Jordan 12 Retro
sku or upca unique unitIPHN11PRO-MX-128GB-VZ-US or AIRJRDN-BLUE-12M
ClassificationA tariff classification for a particular country.
PackagingBreakoutBreakout used to convert outer and inner packages for an individual product like a 10 pack of socks.
NameData TypeDescriptionRequired
doc_typeStringAlways product_json
productsArray<Product>Array of products
versionStringThe version of the specification being used.
NameData TypeDescriptionRequired
classificationsArray<Classification>Customs classifications
country_of_originStringCountry of Origin of the product. If product is sourced from multiple countries, leave this blank and transmit on a per-shipment basis.
customs_descriptionStringA technical description of the product appropriate for presentation to a customs authority.
division_codeStringThe code of the division responsible for selling the product
division_nameStringThe name of the division responsible for selling the product
eanStringEuropean Article Number.
gross_weight_kgsDecimalThe weight of the product including packaging in kilograms.
height_cmsDecimalThe height of the product including packaging.
length_cmsDecimalThe length of the product including packaging.
manufacturer_idStringThe ID of the manufacturer providing the product. If sourced from multiple manufacturers, leave this blank and transmit on a per-shipment basis.
manufacturer_nameStringThe name of the manufacturer providing the product. If sourced from multiple manufacturers, leave this blank and transmit on a per-shipment basis.
minimum_age_restrictionIntegerThe minimum age of persons to which the product may be sold.
net_weight_kgsDecimalThe weight of the product without any packaging in kilograms
packaging_breakoutArray<PackagingBreakout>The list of conversion codes an quantities to represent inner packages within a product
product_categoryStringThe category in which the product fits like (Phones or Men's Footwear)
product_descriptionStringA general description of the product
product_idStringProduct identifier (often correlates to style)
product_nameStringProduct name (like IPhone 11 Max)
production_methodStringIndicates method for how the product was produced. (Batch, One Off, etc.)
reorder_pointDecimalWhen inventory drops to this amount, issue a replenishment order.
reorder_sizeDecimalThe amount of product to order in each replenishment order.
skuStringStock Keeping Unit number. The lowest level of detail at which all products are the same.
source_system_idStringRecord identifier in the system that hosts the master copy of this record.
supplier_idStringThe ID of the supplier providing the product. If sourced from multiple suppliers, leave this blank and transmit on a per-shipment basis.
transmission_uidStringA one-time unique identifying code for this transmission of the product in question. Used for tracing and logging purposes.
unit_of_measureStringUnit of measure code used for maintaining product inventory.
unit_of_measure_descriptionStringDescription of the unit of measure.
unit_sell_priceDecimalThe sell price for a single unit.
upcStringUniversal Product Code number
vat_rateDecimalVAT Rate.
volume_cbmsDecimalVolume of the Product in cubic meters.
web_linkStringProduct website URL.
width_cmsDecimalThe width of the product including packaging.
wto_htsStringThe 6 digit HTS code assigned to the product
NameData TypeDescriptionRequired
country_isoStringCountry of the customs authority for which this classification applies.
effective_end_dateDateTimeThe date after which the classification should no longer be used. If blank, use until replaced.
effective_start_dateDateTimeThe date when the classification should start being used. If blank, use immediately.
hts_1StringThe first HTS code. Do not include periods. (1234567890, not 1234.56.7890).
NameData TypeDescriptionRequired
inner_codeStringInner package code.
inner_countIntegerThe number of inner packages in the outer package.
outer_codeStringOuter package code.

Example