This document will provide you with all informations you need in order to import your current orders into the bookingkit system.
As most Systems support exporting data to a spreadsheet like format we decided to support CSV import. The file must respect the following requirements:
You must first set up your events in bookingkit before importing your orders
| encoding | UTF-8 |
| field separator | , |
| field quotation | " |
| field quotation practice | required for all field containing a "," and optional for the rest |
If you what to see an example of how the file could look like you can download an example file here:
Example file
| Name | Definition | Format / Accepted values | Example value |
|---|---|---|---|
| external_reference | 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 | UTC date of the order placement | YYYY-MM-DD hh:mm:ss | 1970-01-01 00:00:00 |
| service_date | 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 | one of the following: ACCEPTED - an active order CANCELED - a canceled order OPEN - an open request |
ACCEPTED | CANCELED | OPEN | ACCEPTED |
| lang | the language the order has been placed in | language code ISO_639-1, string length = 2 | en |
| currency | currency code for this order | currency code ISO_4217 | EUR |
| name | Full name of the person who placed the order | min length = 3 | John Doe |
| email address of the person who placed the order | valid email address | john.doe@email.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 | one of the following: ACCEPTED - an active booking CANCELED - a canceled booking PENDING - a pending booking |
ACCEPTED | CANCELED | PENDING | ACCEPTED |
| event_id | event id on the bookingkit platform | 32 character string | D6A6BC0DB10694A2D90E3A69648F3A03 |
| booking_vat_rate | the vat rate for this item | decimal | 19 |
| participant_name | name of this participant | min. length = 3 | Jake Weary |
| participant_email | email address of this participant | valid email address | jake.weary@email.com |
| participant_phone | phone number of this participant | digits only | 004911122233344 |
| participant_comment | free text field with commends concerning this specific participant | string | allergic to peanuts |
| participant_price_value | the price this participant paid | decimal | 98.90 |
| participant_price_title | the price level name the participant booked | string | Student price |
| ticket_code | unique string that identifies the ticket for this participant | string alphanumeric including “-” or “_”, no spaces max.length = 40 | T1000-123-01 |
| participant_cancellation_date | 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 | 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 | original value of the voucher at the time of placing the order | decimal | 50 |
| product_title | the name of the product being ordered | string | T-shit size M |
| product_price | price per product | decimal | 9.99 |
| product_amount | amount of this particular product being ordered | integer | 3 |
| required field |
| optional but recommended field |
| optional field |
| fields must have values only when describing a booking |
| fields must have values only when describing a voucher |
| fields must have values only when describing a product |