Inventory (Partial Update)
Description
Sets inventory counts for a variant across one or more stores. The provided counts replace the current inventory values for the specified stores. Stores not included in the request are left unchanged.
See the Aerial Spec for more details.
File Naming Convention
TGEN_inventory_partialupdate_2026-08_<optionalSuffix>.csv
importType:partialupdateapiVersion:2026-08
Columns
Nested object fields are flattened into columns using dot notation (parent.child). Array fields are flattened using zero-based index notation, one element per column (field[0], field[1], and so on).
Note: A whole array cannot be passed in a single column: a literal value such as ['value-1','value-2'] will be rejected. To import multiple array elements, add one indexed column per element. Rows in the table below with type array describe the field as a whole and are not valid CSV column headers.
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
variantId | UUID or external ID of a variant 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 | |
variantId.uuid | UUID of the resource | string | No | |
variantId.externalId | External ID of the resource | string | No | |
counts | A collection of Counts for this inventory request that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (counts[0], counts[1], and so on). | array | No |
counts[0] | Array element | mixed | No | |
counts[0].storeId | UUID or external ID of a store 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 | |
counts[0].storeId.uuid | UUID of the resource | string | No | |
counts[0].storeId.externalId | External ID of the resource | string | No | |
counts[0].count | Inventory count for the store that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | Min: 0 | integer | No |
Sample CSV
See the following inventory 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.