File Format - Store / Store Patch
Store File Format
The first line of a Store CSV file must be the header row.
A store instance is a group of rows in the CSV file that are sequential and include the same required fields. Data relating to fields specified under Base Headers and Multi-Column Headers must be specified in the first row of a store instance. Additional rows of a store instance may only include fields specified under Multi-Row Headers.
Store Patch File Format
The Store Patch file allows users to PATCH partial data for a given store. This means that the integrator does not need to populate every field in the .csv to update a single field. If an integrator wants to remove / set a field as NULL or empty string in Tulip, they can simply provide the string ‘SET_AS_NULL" in the appropriate field and that field will be emptied.
The store patch file format is the same as the Store File format and all rules should be followed when providing a Store Patch file.
Required Headers
To successfully import a store CSV file, the following columns must be included in the header row:
| Column Name | Description | Type |
|---|---|---|
Store ID (Required) | Identification string for a store. This store identifier is referenced by other entities such as Employees, Orders, Tasks, etc. Must be unique for every store | string |
Country ID (Required) | Country of this store. Format: ISO Code 3166 Integers will be resolved to internal identifiers | |
Store Name (Required) | Name of the store | string |
Zone ID (Required) | ID of the zone the state/province/county resides in. Format: ISO 3166-2. Examples can be found here. Integers will be resolved to internal identifiers | integer, string |
Address (Recommended) | Address of the store | string |
City (Recommended) | City the store is in | string |
| integer, string | ||
Disabled (Required) | Whether or not the store is disabled | boolean |
Email (Recommended) | Store’s email | string |
Latitude (Recommended) | Latitude of the store | number |
Longitude (Recommended) | Longitude of the store | number |
Phone Number (Recommended) | Store phone number | string |
Postcode (Recommended) | Store’s postal code | string |
Runner Supported | Whether or not the store supports Runner | boolean |
Monday Open | Time the store opens on Monday | string |
Monday Close | Time the store closes on Monday | string |
Tuesday Open | Time the store opens on Tuesday | string |
Tuesday Close | Time the store closes on Tuesday | string |
Wednesday Open | Time the store opens on Wednesday | string |
Wednesday Close | Time the store closes on Wednesday | string |
Thursday Open | Time the store opens on Thursday | string |
Thursday Close | Time the store closes on Thursday | string |
Friday Open | Time the store opens on Friday | string |
Friday Close | Time the store closes on Friday | string |
Saturday Open | Time the store opens on Saturday | string |
Saturday Close | Time the store closes on Saturday | string |
Sunday Open | Time the store opens on Sunday | string |
Sunday Close | Time the store closes on Sunday | string |
Tax Division | The tax division | string |
Tax Provider Id | Id of the tax provider | string |
Remote Pay Adyen Merchant Account | Merchant account name | string |
Online Store Id | The int ID or the string external ID of the online store associated with this store | integer or string |
LiveConnect Supported | Boolean dictating if store has LiveConnect enabled | boolean |
Fulfull From Multiple Stores Enabled | Whether or not orders placed in this store can be fulfilled from multiple stores | boolean |
Conditional Order Flow Enabled | Whether or not conditional order flow is enabled for the store | boolean |
Twilio Calling Enabled | Whether or not Twilio calling is enabled for the store | boolean |
Clienteling Login Enabled | Whether or not the store can be used as the home store in the Clienteling app | boolean |
Checkout Login Enabled | Whether or not the store can be used as the home store in the Checkout app | boolean |
Mobile Phone | Mobile phone number of the store | string |
Receipt Language ID | Language code to use for receipts from this store | string |
Timezone | Time zone this store is in | string |
Business Entity Name | Business entity name of the store | string |
Store Type External ID | External ID of the store type | string |
Store Type Name | Name of the store type | string |
District Resource External ID | External ID of the store district | string |
District Resource Name | Name of the store district | string |
District Resource | Resource type of the store organization resource (District) | string |
Region Resource External ID | External ID of the store district’s assigned region | string |
Region Resource Name | Name of the store district’s assigned region | string |
Region Resource | Resource type of the store organization resource (Region) | string |
Division Resource External ID | External ID of the store district’s assigned division | string |
Division Resource Name | Name of the store district’s assigned division | string |
Division Resource | Resource type of the store organization resource (Division) | string |
Store Ecommerce Domain | E-Commerce Domain URL of the store | string |
Pending Customer Flow Enabled | Whether or not pending customer flow is enabled for the store | string |
Groups
A group is a class of headers that relate to one another, and may allow for multiple pieces of information to be presented. For example, a customer can have multiple emails, addresses, phone numbers, and more.
Store groups include:
- Custom Attributes
Custom Attributes
There are two ways that custom attributes can be formatted in your CSV file: A Multi-Row Approach or Multi-Column Approach.
Multi-Row Approach
In this approach, one set of column headers is used alongside multiple rows of data. To allow for multiple rows of data, additional rows must include the same Required Headers fields.
Multi-Column Approach
In this approach, multiple sets of column headers may be used alongside one row (the first row) of a store instance. To use these columns multiple times, an identifying number must exist for N and be unique for every new set of columns.
Columns from the Multi-Row Approach cannot be mixed with columns from the Multi-Column Approach in a CSV file for the Custom Attributes group.
The following columns may be included:
| Multi-Row Approach Column Name | Multi-Column Approach Column Name | Description | Type |
|---|---|---|---|
Customer Attribute ID | Custom Attribute N ID | Identifier of the custom attribute | string |
Custom Attribute Value | Custom Attribute N Value | Value of the attribute | string |
Custom Attribute Language ID | Custom Attribute N Language ID | Language of the attribute. Integers will be resolved to internal identifiers | integer, string |
Where N is some positive integer.
Privacy Regions
There are two ways that privacy regions can be formatted in your CSV file: A Multi-Row Approach or Multi-Column Approach.
Multi-Row Approach
In this approach, one set of column headers is used alongside multiple rows of data. To allow for multiple rows of data, additional rows must include the same Required Headers fields.
Multi-Column Approach
In this approach, multiple sets of column headers may be used alongside one row (the first row) of a store instance. To use these columns multiple times, an identifying number must exist for N and be unique for every new set of columns.
Columns from the Multi-Row Approach cannot be mixed with columns from the Multi-Column Approach in a CSV file for the Custom Attributes group.
The following columns may be included:
| Multi-Row Approach Column Name | Multi-Column Approach Column Name | Description | Type |
|---|---|---|---|
Privacy Regions | Privacy Regions N | Privacy region associated to the store | string, integer |
Where N is some positive integer.
Store CSV Example
See the following Store CSV sample file.