Variants (Partial Update)
Description
See the Aerial Spec for more details.
File Naming Convention
TGEN_variants_partialupdate_2025-12_<optionalSuffix>.csv
importType:partialupdateapiVersion:2025-12
Columns
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
uuid | UUID of the resource that can be expressed using a value as defined in its types. | string | No | |
externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
productId | UUID or external ID of a product to assign this variant to. (Creation only) that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
upc | UPC of the variant that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
status | Status of the variant that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | Allowed: available, discontinued, unavailable | string | No |
isFinalSale | Declares this variant is not eligible for returns that can be expressed using a value as defined in its types. | boolean | No | |
isOpenPricePoint | States if the price can be customized that can be expressed using a value as defined in its types. | boolean | No | |
minOpenPricePoint | The minimum open price point for this variant. that can be expressed using a value as defined in its types. | number | No | |
maxOpenPricePoint | The maximum open price point for this variant. that can be expressed using a value as defined in its types. | number | No | |
isSerialized | Is the variant controlled by serial numbers. that can be expressed using a value as defined in its types. | boolean | No | |
images | A collection of Images of the product that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
images[0] | Array element | mixed | No | |
images[0].sourceUrl | The original url of the image. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | Yes | |
images[0].sortOrder | The ascending sort order value to order images for the same product/variant. To set an image as the primary image, please use sortOrder 0. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | integer | No | |
localizedData | A collection of Localizations of the variant that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
localizedData[0] | Array element | mixed | No | |
localizedData[0].languageCode | Language this localization pertains to, follows a pattern of 2 letters and can then have multiple other groups of 2 letters or more. Each block separated by an hyphen. | Pattern: ^[a-z]{2}(-[a-z]{2,})*$ | string | Yes |
localizedData[0].name | Localized variant name that can be expressed using a value as defined in its types. | string | No | |
localizedData[0].description | Localized variant description that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
localizedData[0].url | URL to a localized web page giving more details about the variant that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
attributes | A collection of attribute that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
attributes[0] | Array element | mixed | No | |
attributes[0].name | Name of the attribute | string | Yes | |
attributes[0].languageExternalId | Language this localization pertains to, follows a pattern of 2 letters and can then have multiple other groups of 2 letters or more. Each block separated by an hyphen. | Pattern: ^[a-z]{2}(-[a-z]{2,})*$ | string | No |
attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
optionValues | A collection of option_values that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | array | No | |
optionValues[0] | Array element | mixed | No | |
optionValues[0].uuid | UUID of the resource that can be expressed using a value as defined in its types. | string | No | |
optionValues[0].externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
optionValues[0].type | UUID, External ID or object representation of a option type | string | No | |
optionValues[0].type.uuid | UUID of the resource | array | No | |
optionValues[0].type.uuid[0] | Array element | string | No | |
optionValues[0].type.externalId | External ID of the resource | array | No | |
optionValues[0].type.externalId[0] | Array element | string | No | |
optionValues[0].sortOrder | Sort order of the value against other values of this type that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | integer | No | |
optionValues[0].value | The value used to render the option, it can be a string or a code that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
optionValues[0].localizedData | A collection of Localizations of the option value that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
optionValues[0].localizedData[0] | Array element | mixed | No | |
optionValues[0].localizedData[0].languageCode | Language this localization pertains to, follows a pattern of 2 letters and can then have multiple other groups of 2 letters or more. Each block separated by an hyphen. | Pattern: ^[a-z]{2}(-[a-z]{2,})*$ | string | Yes |
optionValues[0].localizedData[0].name | Localized option value name that can be expressed using a value as defined in its types. | string | No | |
optionValues[0].localizedData[0].presentation | Localized option value presentation string that can be expressed using a value as defined in its types. | string | No | |
optionValues[0].optionValueCategories | A collection of optionValueCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | array | No | |
optionValues[0].optionValueCategories[0] | Array element | mixed | No | |
optionValues[0].optionValueCategories[0].uuid | UUID of the resource that can be expressed using a value as defined in its types. | string | No | |
optionValues[0].optionValueCategories[0].externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
optionValues[0].optionValueCategories[0].localizedData | A collection of Localizations of the option value category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | array | No | |
optionValues[0].optionValueCategories[0].localizedData[0] | Array element | mixed | No | |
optionValues[0].optionValueCategories[0].localizedData[0].languageCode | Language this localization pertains to, follows a pattern of 2 letters and can then have multiple other groups of 2 letters or more. Each block separated by an hyphen. | Pattern: ^[a-z]{2}(-[a-z]{2,})*$ | string | Yes |
optionValues[0].optionValueCategories[0].localizedData[0].name | Localized option value category name that can be expressed using a value as defined in its types. | string | No | |
optionValues[0].optionValueCategories[0].parentCategory | UUID or external ID of a parent option value category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a structure of {“uuid”: “string”, “externalId”: “string”} (to provide a more expressive identifier) or a value as defined in its types. | string | No | |
optionValues[0].optionValueCategories[0].parentCategory.uuid | UUID of the resource | array | No | |
optionValues[0].optionValueCategories[0].parentCategory.uuid[0] | Array element | string | No | |
optionValues[0].optionValueCategories[0].parentCategory.externalId | External ID of the resource | array | No | |
optionValues[0].optionValueCategories[0].parentCategory.externalId[0] | Array element | string | No |
Sample CSV
See the following variants CSV sample file.
Note: The sample CSV may contain sample ID fields which reference other resources that do not match the data in your environment. You may omit any non-required fields from the sample CSV, reference the table above for required fields.