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.
Spec
The following table shows the accepted CSV columns for the stores entity. Note that any columns including N
denote a dynamic integer. A column specified as Field N
signifies that you can use columns Field 1
, Field 2
, …, Field N
to allow for multiple values per record of the given field, similar to an array.
CSV Header | Data Type | Group | Required | Description |
---|---|---|---|---|
Store ID | string | Yes | External identifier of the record | |
Address | string | No | Street number and address of the Store | |
City | string | No | City in which the Store is located | |
Country ID | integerORstring | Yes | ID of the Country in which the Store is located (externalId resolvable) | |
Disabled | boolean | No | Whether or not the Store is disabled | |
Email | string | No | Email address associated with the Store | |
Latitude | number | No | Latitude of the Store’s location (between -90 and 90 inclusive; decimal precision: 6) | |
Longitude | number | No | Longitude of the Store’s location (between -180 and 180 inclusive; decimal precision: 6) | |
Store Name | string | No | Name of the Store | |
Phone Number | string | No | Phone number associated with the Store (using E164 format) | |
Postcode | string | No | Postal code of the Store | |
Runner Supported | boolean | No | Whether or not the Store supports the Tulip Runner app | |
Zone ID | integerORstring | No | ID of the Zone in which the Store is located (externalId resolvable) | |
Online Store Id | integerORstring | No | ||
Online Store External Id | string | No | ||
Monday Open | string | Monday | No | |
Monday Close | string | Monday | No | |
Tuesday Open | string | Tuesday | No | |
Tuesday Close | string | Tuesday | No | |
Wednesday Open | string | Wednesday | No | |
Wednesday Close | string | Wednesday | No | |
Thursday Open | string | Thursday | No | |
Thursday Close | string | Thursday | No | |
Friday Open | string | Friday | No | |
Friday Close | string | Friday | No | |
Saturday Open | string | Saturday | No | |
Saturday Close | string | Saturday | No | |
Sunday Open | string | Sunday | No | |
Sunday Close | string | Sunday | No | |
Custom Attribute ID | string | Attribute Values | No | Attribute to be used as key in the key/value pair (externalId resolvable) |
Custom Attribute Value | string | Attribute Values | No | Value to appear in this key/value pair |
Custom Attribute Language ID | integerORstring | Attribute Values | No | Language ID for the language in which this value appears; use 0 if it is not localized (externalId resolvable) |
Custom Attribute N ID | string | Attribute Values N | No | |
Custom Attribute N Value | string | Attribute Values N | No | |
Custom Attribute N Language ID | integerORstring | Attribute Values N | No | |
LiveConnect Supported | boolean | No | Whether or not the Store supports the Live Connect App | |
Mobile Phone | string | No | ||
Catalog | integerORstring | Catalogs | No | |
Catalog N | integerORstring | Catalogs N | No | Array of catalog IDs of Store (externalId resolvable) |
Receipt Language ID | integerORstring | No | ||
Receipt Language External ID | integerORstring | No | ||
Privacy Regions | string | Privacy Regions | No | |
Privacy Regions N | string | Privacy Regions | No | |
Tax Division | string | No | ||
Tax Provider Id | string | No | ||
Remote Pay Adyen Merchant Account | string | No | ||
Chat Source | string | No |
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.
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.