File Format - Price
Tulip allows you to define prices per variant and currency on four levels:
- per store
- per zone (i.e. region, state, province, etc. depending on the country)
- per country
- globally
The price that is used for your variant and currency will be the first available price from the above list, in order. For example, if you have a store level price for a variant and a zone level price, the store level price “wins”.
Price File Format
The first line of a Price CSV file must be the header row.
A price 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 price instance. Additional rows of a price instance may only include fields specified under Multi-Row Headers.
Required Headers
To successfully import a price CSV file, the following columns that must be included in the header row.
| Column Name | Description | Type |
|---|---|---|
Price ID(Required)* | Unique identifier for a price combination | string |
Product ID* | ID of the product this inventory is associated with. If not provided lookup via variantId will be done. | string |
Variant ID(Required)* | ID of the variant to which this price applies | string |
Currency ID(Required)* | ID of the currency to which this price applies. See supported currencies Integers will be resolved to internal identifiers | integer, string |
Country ID (Required)* | ID of the country to which this price applies. Integers will be resolved to internal identifiers | integer, string |
Store ID (Required)* | ID of the store to which this price applies | string |
Zone ID (Required)* | ID of the State/Province/County in which this price applies in ISO-3166-2:2020 format Examples can be found here. Integers will be resolved to internal identifiers | integer, string |
Note: You must supply values for either
Country IDorStore IDorZone ID.
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.
Price groups include:
Price Values
There are two ways that price values 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 price 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 Price Values group.
The following columns may be included:
| Multi-Row Approach Column Name | Multi-Column Approach Column Name | Description | Type |
|---|---|---|---|
Price Value (Required)* | Price Value N | Value of this price value (decimal precision:float) | number |
Price Value Type ID (Required)* | Price Value N Type ID | regular or saleIntegers will be resolved to internal identifiers | integer, string |
Where N is some positive integer
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 price. 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 |
|---|---|---|---|
Custom Attribute ID (Required)* | Custom Attribute N ID | Identifier of the custom attribute | string |
Custom Attribute Value (Required)* | Custom Attribute N Value | Value of the attribute | string |
Custom Attribute Language ID (Required)* | Custom Attribute N Language ID | Language of the attribute. Integers will be resolved to internal identifiers | integer, string |
Where N is some positive integer.
Supported Currency IDs
| Currency Name | Code |
|---|---|
| US Dollar (USD) | USD |
| Euro (EUR) | EUR |
| Canadian Dollar (CAD) | CAD |
| British Pound (GBP) | GBP |
| Swiss Franc | CHF |
| HK Dollar (HK) | HKD |
| Hungarian Forint | HUF |
| Swedish Krona | SEK |
| Danish Krone | DKK |
| Norwegian Kroner | NOK |
| Australian Dollar | AUD |
| Japanese Yen | JPY |
| Chinese Renminbi | RMB |
| New Taiwan Dollar | TWD |
| United Arab Emirates Dirham | AED |
| Singapore Dollar | SGD |
| Czech Koruna | CZK |
| Chinese Yuan Renminbi | CNY |
| Malaysian Ringgit | MYR |
| Macanese Pataca | MOP |
| Thai Baht | THB |
| South Korean Won | KRW |
| Mexican Peso | MXN |
| Polish Zloty | PLN |
| Romanian Leu | RON |
| New Zealand Dollar | NZD |
| Bahraini Dinar | BHD |
| Panamanian Balboa | PAB |
| Dominican Peso | DOP |
| Aruban Florin | AWG |
| South African Rand | ZAR |
Price CSV Example
See the following Price CSV sample file.