Documentation Home

Product Import

Products and SKUs can be imported into the admin either directly into production or into a user sandbox for review.

Adding vs Updating

The externalId is the key to distinguish between Add and Update. If a row has an externalId that is already present, it will update the product with the information in that row.
If the externalId is not present, new category is created.

Default Import Specification and Fields

These are the fields defined by DefaultProductImportSpecification:

Column name Description Required
SKU Number externalId of the product/SKU Yes
SKU Indicator Indicate if this row is for SKU Yes for SKUs only
Product URL URL for the product No
Product Title Name for the product/SKU Yes
Product Description Description for the product/SKU Yes for Products only
Default Category Id Default category for the product No
Retail Price Price for the product/SKU Yes
UPC UPC for the product/SKU No
Available Quantity Available Quantity for the product/SKU No
Image Url(s) Images for the product/SKU No
Fulfillment Type Fulfillment type for product No
ProductAttribute[] Custom Attribute for product No
options[] Product options for the SKUs Yes for SKUs only
Product Title(SPANISH) Spanish translation for product name No
Product Description(SPANISH) Spanish translation for product description No

Special Fields

These are fields don't have dedicated fields, so they are handled differently.

  • Default Category Id - Format is numberic value of ID. Establishes the relationship between product and category.
  • Image Url(s) - See Image Parsing
  • ProductAttribute - Format for the header is ProductAttribute[name]. Eg ProductAttribute[heatRange]. Attribute can be new.
  • options - Format for the header is options[AttributeName]. Eg options[COLOR]. Product Option must exist already and its Attribute name should be used.
  • Product Title(SPANISH) - Translations are imported in a single table. Column Headers of file, locale and field name can be defined in import Specification.

Importing Products and Skus

Product imports can also handle multi-Sku products that are resolvable by different product options. Skus can be specified by including SKUs right below its parent product and indicating SKU by having its parent productId or something in the SKU Indicator Column. Here is an example of importing products:

SKU Number,SKU Indicator,Product Title,Product Description,Product Description(SPANISH),Default Category Id,Product URL,Retail Price,UPC,Available Quantity,ProductAttribute[Color],options[SIZE],Image Url(s)
20001,,ProductA,ProductA is awesome,¡ ProductA es increíble!,2007,/mens/ProductA,10.99,,300,Red,,/cmsstatic/myFolder/pic1.jpg
20002,20001,ProductA,This is SKU,¡ SKU es increíble!,,,10.99,28220002,300,Red,S,
20003,20001,ProductA,This is SKU,¡ SKU es increíble!,,,10.99,28220003,300,Red,M,
20004,20001,ProductA,This is SKU,¡ SKU es increíble!,,,10.99,28220004,300,Blue,L,
20005,20001,ProductA,This is SKU,¡ SKU es increíble!,,,10.99,28220005,300,Blue,XL,
20006,,ProductB,ProductB is awesome!,¡ ProductB es increíble!,2007,/mens/ProductB,10.99,,300,Red,,/cmsstatic/myFolder/pic2.jpg
20007,20006,ProductB,This is SKU,¡ SKU es increíble!,,,10.99,28220007,300,Red,S,
20008,20006,ProductB,This is SKU,¡ SKU es increíble!,,,10.99,28220008,300,Red,M,
20009,20006,ProductB,This is SKU,¡ SKU es increíble!,,,10.99,28220009,300,Blue,L,
20010,20006,ProductB,This is SKU,¡ SKU es increíble!,,,10.99,28220010,300,Blue,XL,
20011,,ProductC,ProductC is awesome,¡ ProductC es increíble!,2008,/womens/ProductC,10.99,28220011,300,,,/cmsstatic/myFolder/pic3.jpg|/cmsstatic/myFolder/pic4.jpg
20012,,ProductD,ProductD is awesome,¡ ProductD es increíble!,2008,/womens/ProductD,10.99,28220012,300,,,
20013,,ProductE,ProductE is awesome,¡ ProductE es increíble!,2008,/womens/ProductE,10.99,28220013,300,,,
20014,,ProductF,ProductF is awesome,¡ ProductF es increíble!,2008,/womens/ProductF,11.99,28220014,300,Blue,,