Products (Partial Update)
Description
Partially update resource
See the Aerial Spec for more details.
File Naming Convention
TGEN_products_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 | |
upc | UPC of the product 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 product that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | Allowed: disabled, active, soldout, unavailable, duplicate, comingSoon, ingram | string | No |
isFinalSale | Are sales for this product final? | boolean | No | |
taxation | N/A | mixed | No | |
taxation.taxClassCode | Tax class code to apply to product when calculating taxes on third party systems. The taxClassCode and taxCode may be used together. However, neither should be set if taxId is provided, as it is mutually exclusive with them. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
taxation.taxCode | Tax code to apply to product when calculating taxes on third party systems. The taxClassCode and taxCode may be used together. However, neither should be set if taxId is provided, as it is mutually exclusive with them. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
taxation.taxId | Tax ID to apply to product when calculating taxes on the internal Tulip Tax Calculation system. The taxClassCode and taxCode may be used together. However, neither should be set if taxId is provided, as it is mutually exclusive with them. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | integer | 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. 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 product 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 product name that can be expressed using a value as defined in its types. | string | No | |
localizedData[0].description | Localized product 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].subtitle | Localized subtitle or tagline of the product that can be expressed using a value as defined in its types. | string | No | |
localizedData[0].pdfUrl | URL to a localized PDF document giving more details about the product 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 product 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 | |
variants | A collection of variant that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | array | No | |
variants[0] | Array element | mixed | No | |
variants[0].uuid | UUID of the resource that can be expressed using a value as defined in its types. | string | No | |
variants[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 | |
variants[0].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 | |
variants[0].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 |
variants[0].isFinalSale | Declares this variant is not eligible for returns | boolean | No | |
variants[0].isOpenPricePoint | States if the price can be customized | boolean | No | |
variants[0].minOpenPricePoint | The minimum open price point for this variant. | number | No | |
variants[0].maxOpenPricePoint | The maximum open price point for this variant. | number | No | |
variants[0].isSerialized | Is the variant controlled by serial numbers. | boolean | No | |
variants[0].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 | |
variants[0].images[0] | Array element | mixed | No | |
variants[0].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 | |
variants[0].images[0].sortOrder | The ascending sort order value to order images for the same product/variant. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | integer | No | |
variants[0].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 | |
variants[0].localizedData[0] | Array element | mixed | No | |
variants[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 |
variants[0].localizedData[0].name | Localized variant name that can be expressed using a value as defined in its types. | string | No | |
variants[0].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 | |
variants[0].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 | |
variants[0].attributes[0] | Array element | mixed | No | |
variants[0].attributes[0].name | Name of the attribute | string | Yes | |
variants[0].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 |
variants[0].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 | |
variants[0].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 | |
variants[0].optionValues[0] | Array element | mixed | No | |
variants[0].optionValues[0].uuid | UUID of the resource that can be expressed using a value as defined in its types. | string | No | |
variants[0].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 | |
variants[0].optionValues[0].type | UUID, External ID or object representation of a option type | string | No | |
variants[0].optionValues[0].type.uuid | UUID of the resource | string | No | |
variants[0].optionValues[0].type.refNum | External ID of the resource | string | No | |
variants[0].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 | |
variants[0].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 | |
variants[0].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 | |
variants[0].optionValues[0].localizedData[0] | Array element | mixed | No | |
variants[0].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 |
variants[0].optionValues[0].localizedData[0].name | Localized option value name that can be expressed using a value as defined in its types. | string | No | |
variants[0].optionValues[0].localizedData[0].presentation | Localized option value presentation string that can be expressed using a value as defined in its types. | string | No | |
catalogs | A collection of catalogs that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | array | No | |
catalogs[0] | Array element | mixed | No | |
categories | A collection of categories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | array | No | |
categories[0] | Array element | mixed | No |
Sample CSV
See the following products CSV sample file.