Data File Upload

Upload Orders
Order data should be provided with each line item as a separate row. Hence an order with three items should be represented with three rows in the .csv file. Each row requires the required data fields below, even though the values are duplicates across the same order.
Important! The file must be named orders.csv
Field name
Data type
Required
Example value
city
String
Required
"New York"
completion_date_gmt
Timestamp
Optional
Check accepted formats​
country
String
Required
"US" or "USA" or "United States"
currency
String
Required
"USD"
date_created_gmt
Timestamp
Required
Check accepted formats​
date_modified_gmt
Timestamp
Optional
Check accepted formats​
email
String
Required
"me@my-store.com"
first_name
String
Optional
"John"
last_name
String
Optional
"Doe"
order_id
Number
Required
100423
phone
String
Optional
"+1 999 111 333"
status
String
Required
"completed"
order_value
Number
Required
74.87
zip_code
String
Optional
"10800"
line_item_product_id
Number
Required
88293
line_item_price
Number
Required
57.39
line_item_name
String
Optional
"Example product"
line_item_subtotal_tax
Number
Optional
4.59
line_item_total_tax
Number
Optional
4.59
line_item_tax_class
String
Optional
"Class A"
line_item_quantity
Number
Required
1
line_item_variation_id
Number
Optional
12345
line_item_sku
String
Optional
"sku 123"
line_item_subtotal
Number
Optional
57.40
line_item_total
Number
Optional
57.40
Upload Product Catalog
Each file upload of the product catalog will overwrite any already uploaded entry. Hence, the full catalog should be uploaded each time. 
Only base products are required to be uploaded as part of the product catalog. Product variants are currently not supported.
Important! The file must be named products.csv
Field name
Data type
Required
Example value / comment
average_rating
Number
Optional
3.0
categories
String
Optional
"Category A, Category B"
currency
String
Required
"USD"
description
String
Optional
"A product description"
image
String
Required
URL to the main product image
image2
String
Optional
URL to secondary image
link
String
Required
URL to product page
name
String
Required
"Product name / title"
on_sale
Boolean
Optional
True/False
product_id
Number
Required
100078
price
Number
Required
27.9
rating_count
Number
Optional
7
sku
String
Optional
"MS71083"
​

Connect your store - Previous

API Reference

Next - Connect your store

Data Types & Formats

Last updated 2 months ago

Field name	Data type	Required	Example value
city	String	Required	"New York"
completion_date_gmt	Timestamp	Optional	Check accepted formats
country	String	Required	"US" or "USA" or "United States"
currency	String	Required	"USD"
date_created_gmt	Timestamp	Required	Check accepted formats
date_modified_gmt	Timestamp	Optional	Check accepted formats
email	String	Required	"me@my-store.com"
first_name	String	Optional	"John"
last_name	String	Optional	"Doe"
order_id	Number	Required	100423
phone	String	Optional	"+1 999 111 333"
status	String	Required	"completed"
order_value	Number	Required	74.87
zip_code	String	Optional	"10800"
line_item_product_id	Number	Required	88293
line_item_price	Number	Required	57.39
line_item_name	String	Optional	"Example product"
line_item_subtotal_tax	Number	Optional	4.59
line_item_total_tax	Number	Optional	4.59
line_item_tax_class	String	Optional	"Class A"
line_item_quantity	Number	Required	1
line_item_variation_id	Number	Optional	12345
line_item_sku	String	Optional	"sku 123"
line_item_subtotal	Number	Optional	57.40
line_item_total	Number	Optional	57.40