Variant dimensions
The descriptors give details of the variant dimensions.
Dimension descriptor JSON data
Dimension descriptors are JSON objects that describe an individual dimension.
| Attribute | Data type | Required | Description |
|---|---|---|---|
heading | string | No | The heading for the product dimension options. For example, “color” or “size”. |
columns | JSON | Yes | Column descriptor. The column names describing this dimension. For more information, see Column descriptor JSON data. |
Before you send your files, consider using a JSON validator.
Column descriptor JSON data
The column descriptor JSON object is a subtype of dimension descriptor. The value of each attribute is the name of a column in the same file, and the name of the attribute specifies the type of the attribute. If you declare a column for an attribute, the column is required.
note
You may include either image_url or color_hex_code in a column descriptor, but not both.
| Attribute | Data type | Related column data type | Required | Description |
|---|---|---|---|---|
display_text | string | string | Yes | The name of the column that holds the user-facing text that describes variant dimension. |
heading | string | string | Yes | The heading name of the product dimension. |
image_url | string | URL | No | The image URL for the product dimension. |
color_hex_code | string | RGB hex code | No | The RGB hex code for the product dimension. |
order | string | Integer | No | The order in which the product dimensions are displayed. |