Store Districts (Full Update)
Description
The district resource determines which Store District Resource is targeted. If a district identifier is provided, it must reference an existing district resource: the Store District Resource anchored to it is updated, or created when that district resource is not part of one yet. If a district object is provided, it is matched on its external identifier: an existing Store District Resource is updated, otherwise one is created. For the region and division resources, if an identifier is provided and the identifier exists, it will update the reference to the Store Organization Resource for this District Resource. If an object is provided, it will perform an upsert on the Store Organization Resource based on the identifier.
See the Aerial Spec for more details.
File Naming Convention
TGEN_districts_fullupdate_2026-08_<optionalSuffix>.csv
importType:fullupdateapiVersion: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 |
|---|---|---|---|---|
district | Unique Tulip identifier of an existing Store Organization Resource that maps to a district, or district object | mixed | Yes | |
district.externalId | External identifier of the Store Organization Resource | Max Length: 255 | string | Yes |
district.name | The name of the Store Organization Resource | Max Length: 255 | string | Yes |
district.resource | The type of resource this Store Organization Resource is. Required when creating a resource. When updating an existing resource, omitting this field keeps the current type. | Allowed: Division, Region, District | string | No |
region | Unique Tulip identifier of the Store Organization Resource that maps to a region, or region object | mixed | No | |
region.externalId | External identifier of the Store Organization Resource | Max Length: 255 | string | Yes |
region.name | The name of the Store Organization Resource | Max Length: 255 | string | Yes |
region.resource | The type of resource this Store Organization Resource is. Required when creating a resource. When updating an existing resource, omitting this field keeps the current type. | Allowed: Division, Region, District | string | No |
division | Unique Tulip identifier of the Store Organization Resource that maps to a division, or division object | mixed | Yes | |
division.externalId | External identifier of the Store Organization Resource | Max Length: 255 | string | Yes |
division.name | The name of the Store Organization Resource | Max Length: 255 | string | Yes |
division.resource | The type of resource this Store Organization Resource is. Required when creating a resource. When updating an existing resource, omitting this field keeps the current type. | Allowed: Division, Region, District | string | No |
Sample CSV
See the following districts 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.