Order import CSV specification

Bookingkit provides an order import feature. You can import orders by uploading a file. As most Systems support exporting data to a spreadsheet like format, we decided to support CSV file format. The file must respect the requirements described on this page.

Before you begin: Set up your inventory first (experiences and prices) in bookingkit before importing your orders.

File format specifications

Property	value
encoding	UTF-8
field separator	,
field quotation	"
field quotation practice	required for all field containing a "," and optional for the rest

Downloads

For your convenience, we've prepared an empty template and an example file.

• Template file
• Example file

Fields specifications

Name	Definition	Format / Accepted values	Example value
external_reference 1	Unique string to identify to order, order code or order id in your system	string alphanumeric including “-” or “_”, no spaces max.length = 40	ABC-1234_56
date 2	UTC date of the order placement	YYYY-MM-DD hh:mm:ss	1970-01-01 00:00:00
service_date 3	UTC date of the booking date	YYYY-MM-DD hh:mm:ss	1970-01-01 00:00:00
expire_date	UTC date when the order is automatically canceled	YYYY-MM-DD hh:mm:ss	1970-01-01 00:00:00
status 1	One of the following: ACCEPTED - an active order, CANCELED - a canceled order, OPEN - an open request	ACCEPTED | CANCELED | OPEN	ACCEPTED
lang 1	The language the order has been placed in	language code ISO_639-1, string length = 2	en
currency 1	Currency code for this order	currency code ISO_4217	EUR
name 1	Full name of the person who placed the order	min length = 3	John Doe
email 2	Email address of the person who placed the order	valid email address	john.doe@example.com
company	The company name for invoice purpose	string	My company Inc.
phone	Telephone number for the person who placed the order	digits only	004910020030040
street	Street address of the person who placed the order	string	Street Name
streetnr	Street number / house number address of the person who placed the order	string	64
zip	Postal code of the person who placed the order	string	10113
city	City address of the person who placed the order	string	Berlin
country_iso_code	Country code address of the person who placed the order	ISO_3166-1 alpha-2	DE
comment	Free text field with comments concerning this specific order	string	we only speak english, I hope that is not a problem
payment_date	UTC date of the payment, if not filled the order will be displayed as unpaid	YYYY-MM-DD hh:mm:ss	1970-01-01 00:00:00
cancellation_date	UTC date of the cancellation, ONLY in combination with status = "CANCELED"	YYYY-MM-DD hh:mm:ss	1970-01-01 00:00:00
additional_discount	An additional discount awarded for this order	decimal number	12.50
shipping_country	Country code of the delivery address	ISO_3166-1 alpha-2	de
shipping_city	City name of the delivery address	string	Berlin
shipping_zip	Postal code of the delivery address	string	10110
shipping_street	Street name of the delivery address	string	Delivery road
shipping_streetnr	Street number / house number address of the delivery address	string	2
shipping_name	Full name of the person for the shipping address	min. length = 3	Jane Doe
booking_status 3	One of the following: ACCEPTED - an active booking, CANCELED - a canceled booking, PENDING - a pending booking	ACCEPTED | CANCELED | PENDING	ACCEPTED
event_id 3	Experience identifier	32 character string	D6A6BC0DB10694A2D90E3A69648F3A03
booking_vat_rate 3	The vat rate for this item	decimal	19
participant_name 3	Name of this participant	min. length = 3	Jake Weary
participant_email 3	Email address of this participant	valid email address	jake.weary@email.com
participant_phone 3	Phone number of this participant	digits only	004911122233344
participant_comment 3	Free text field with comments concerning this specific participant	string	allergic to peanuts
participant_price_value 3	The price this participant paid	decimal	98.90
participant_price_title 3	The price level name the participant booked	string	Student price
ticket_code 3	Unique string that identifies the ticket for this participant	string alphanumeric including “-” or “_”, no spaces max.length = 40	T1000-123-01
participant_cancellation_date 3	UTC date of the cancellation for this particular participant if set the participant will be cancelled and his ticket will be invalid	YYYY-MM-DD hh:mm:ss	1970-01-01 00:00:00
voucher_code 4	Unique string that identifies this voucher, this code will be accepted during the checkout for future orders. Use this only if this order is buying a voucher, not if a voucher has been used to pay for this order	String alphanumeric including “-” or “_”, no spaces max.length = 40	VCH-475-RRT
voucher_value 4	Original value of the voucher at the time of placing the order	decimal	50
product_title 5	The name of the product being ordered	string	T-shit size M
product_price 5	Price per product	decimal	9.99
product_amount 5	Amount of this particular product being ordered	integer	3

Footnotes

1. required field ↩ ↩² ↩³ ↩⁴ ↩⁵

2. optional but recommended field ↩ ↩²

3. fields must have values only when describing a booking ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶ ↩⁷ ↩⁸ ↩⁹ ↩¹⁰ ↩¹¹ ↩¹²

4. fields must have values only when describing a voucher ↩ ↩²

5. fields must have values only when describing a product ↩ ↩² ↩³