Product Import
Special Column Headers
Column name | Description |
---|---|
media | see Media Format |
defaultCategory | Either the Broadleaf primary key or the externalId of a Category to associate to the record's default category |
parentCategories | See the Category Relationship Format |
attributes | See the Attributes Format |
product | Indicates that this record will be inserted as a Sku, associated to the given product's additional Skus. Accepts either a product's externalId or Broadleaf primary key |
options | See the Options Format |
Field-based Columns
Importing Skus
Product imports can also handle multi-Sku products like T-shirts that are resolvable by different product options. Skus can be specified by first inserting a record for the product, and then referencing that product for each individual Sku. Here is an example of importing a single product:
externalId,retailPrice,name,manufacturer,longDescription,defaultCategory,url
hand-drawn-shirt,10.99,Hand Drawn Shirt,Broadleaf,Some Description,top-level-category,/hand-drawn-shirt
This example uses bean property names to fill in columns. However, you can also use field names for what you see directly in the admin application (e.g. the friendlyName
property of @AdminPresentation
for that property):
External ID,Retail Price,Name,Manufacturer,Description,Default Category,Url
hand-drawn-shirt,10.99,Hand Drawn Shirt,Broadleaf,Some Description,top-level-category,/hand-drawn-shirt
Below is an example of adding a multi-sku product with product options. New product options and product option values are dynamically created if they do not exist yet via a case-sensitive comparison of the name and value.
externalId,product,retailPrice,name,manufacturer,longDescription,options,defaultCategory,url
hand-drawn-shirt,,10.99,Hand Drawn Shirt,Broadleaf,Some Description,,top-level-category,/hand-drawn-shirt
,hand-drawn-shirt,,,,,size[SELECT]:small|color[COLOR]:blue|cut[SELECT]:mens,,
,hand-drawn-shirt,12.99,,,,size[SELECT]:XL|color[COLOR]:red|cut[SELECT]:mens,,