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.
Spec
The following table shows the accepted CSV columns for the prices 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 |
|---|---|---|---|---|
Price ID | string | Yes | External ID of the record | |
Product ID | string | No | ID of the Product to which this Price applies (externalId resolvable) | |
Variant ID | string | Yes | ID of the Variant to which this Price applies (externalId resolvable) | |
Country ID | integerORstring | No | ID of the Country in which this Price applies (externalId resolvable) | |
Store ID | string | No | ID of the Store to which this Price applies (externalId resolvable) | |
Currency ID | integerORstring | No | ID of the Currency in which this Price is given (externalId resolvable) | |
Zone ID | integerORstring | No | ID of the Zone in which this Price applies (externalId resolvable) | |
Price Value | number | Price Values | No | Value of this Price Value (decimal precision: float) |
Price Value Type ID | integerORstring | Price Values | No | ID of the Price Type of this Price Value (externalId resolvable) |
Price Value Tax Inclusive | integer | Price Values | No | |
Price Value N | number | Price Values N | No | |
Price Value N Type ID | integerORstring | Price Values N | No | |
Price Value N Tax Inclusive | integer | Price Values N | 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 |
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 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:
| Required | Multi-Row Approach Column Name | Multi-Column Approach Column Name | Description | Type |
|---|---|---|---|---|
| Yes* | Price Value | Price Value N | Value of this price value (decimal precision:float) | number |
| Yes* | Price Value Type ID | 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:
| Required | Multi-Row Approach Column Name | Multi-Column Approach Column Name | Description | Type |
|---|---|---|---|---|
| Yes* | Custom Attribute ID | Custom Attribute N ID | Identifier of the custom attribute | string |
| Yes* | Custom Attribute Value | Custom Attribute N Value | Value of the attribute | string |
| Yes* | 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.
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.