File Prefix | PRODUCT-VARIANTS |
Current Version | V2 |
Product variants express the variations a given product can be available in.
Every product has to have at least one or more variant defined
Attribute | Format | Length | Required | Description | Example |
product_ref | Alphanumeric | 1-255 | Yes | Unique product reference descriptor | 103495 |
sku | Alphanumeric | 1-255 | Yes | SKU of product variant | B01N53LF |
barcode | Alphanumeric | 1-255 | No | Barcode (UPC, EAN, ISBN, etc.) | 03600291452 |
option_1_name | Alphanumeric | 1-255 | No | 1st variation | Color |
option_1_value | Alphanumeric | 1-255 | No | Value for that sku | Green |
option_2_name | Alphanumeric | 1-255 | No | 2nd variation | Size |
option_2_value | Alphanumeric | 1-255 | No | Value for that sku | 42.5 |
option_3_name | Alphanumeric | 1-255 | No | 3nd variation | Material |
option_3_value | Alphanumeric | 1-255 | No | Value for that sku | Gold |
language_code | ISO 639-1 Must belong to our supported languages | 2 | Conditionally | Language used in options and values. Must be present if options and values are specified | en |
store_refs | Alphanumeric ; separated list. | 1-255 | No | Product only exists for these stores. If omitted, available to all stores | B32;C85 |
published | Boolean [TRUE|FALSE] | | Yes | Determine if the variant should be shown or searchable in the collection view. If not published it will be hidden but can still be attached to a sale | TRUE |
sku
is unique and case insensitive (e.g. B01N53LF is considered the same as b01n53Lf)
Notes
option_x_name
can be used to split product in the collection view via a company wide configuration. For example, Color could be selected, so that each color variant of a given product would show as a top level image in the collection view.
If a product does not have multiple variants, for example a shoe cleaning kit, a variant should be created with no options.
Example
Here are some example of common options for variants for different product types:
| Option 1 | Option 2 | Option 3 |
Apparel | Color | Size | |
Shoes | Color | Size | Width |
Jewelry | Material | Size | |
Localization
To localize option names and values, multiple rows can be sent for a given product_ref
and sku
combination with a different language_code
.
Example:
product_ref,sku,barcode,option_1_name,option_1_value,option_2_name,option_2_value,option_3_name,option_3_value,language_code,store_ids,published
103495,B01N53LF,03600291452,Color,Green,Size,11,,,en,B32;C85,TRUE
103495,B01N53LF,03600291452,Couleur,Vert,Taille,42.5,,,fr,B32;C85,TRUE
Editing and deleting options
Imported options (option_1_value
, option_2_value
and option_3_value
) replace the current options. For example:
- A variant as an option named
color
with the value green
- A file for this variant is imported with
option_1_name
: color
and option_1_value
: red
- Now this variant as the option named
color
with the value red
(option green
as been removed from this variant)
Imported options (option_1_name
, option_2_name
and option_3_name
) with blank corresponding values will delete current options. For example:
- A variant as an option named
color
with the value green
- A file for this variant is imported with
option_1_name
: color
and option_1_value
: ""
- Now this variant don’t have
color
options anymore