Data specification
Bare Customer
| Name | Required | Data type | Value | Example |
|---|---|---|---|---|
email_hash | ✓ | String | email MDP hashed in normalize format* | "bdd139eaa71daffb11b1133f5a9bd60e" |
facebook_id_hash | String | MD5 hash Facebook ID | "202cb962ac59075b964b07152d234b70" | |
customer_id | String | Unique id of registered customer | "c9f0f895fb98ab9159f51fd0297e236d" |
*small letters without spaces. Example (ondrej.s@example.com)
Bare Order
| Name | Required | Data type | Value | Example |
|---|---|---|---|---|
order_id | ✓ | String | Unique id of order | "ooxoh9Oogh0obi7E" |
created | ✓ | String | Date and time of order creation in ISO 8601 format | "2013-07-22T14:57:18+00:00" |
approx_total_price | ✓ | Number | Approximate total price incl. VAT (without shipping): 1 = price ≤ 500 CZK, 2 = price > 500 CZK | 1 |
billing_address | ✓ | BareAddress | Billing address of customer | |
delivery_address | BareAddress | Delivery address of customer. Note: If its not specified you billing address | ||
is_paid | ✓ | Boolean | Order has been paid. Orders via Twisto must always have set is_paid to false | true |
is_shipped | ✓ | Boolean | Order has been shipped | true |
is_delivered | Boolean | Order has been delivered | false | |
is_returned | Boolean | Order, or its part has been returned | false |
Bare Address
| Name | Required | Data type | Value | Example |
|---|---|---|---|---|
street | String | Street | "Karla Engliše 3208/5" | |
city | String | City | "Praha 5" | |
zipcode | ✓ | String | ZIP code | "15000" |
country | String | Country code in ISO 3166-1 alpha-2 format. Note If not specified use "CZ" | "CZ" | |
phones_hash | Array<String> | MD5 hashes of customer's phone numbers | ["bdd139eaa71daffb11b1133f5a9bd60e", "202cb962ac59075b964b07152d234b70"] or ["bdd139eaa71daffb11b1133f5a9bd60e"] |
Customer
| Name | Required | Data type | Value | Example |
|---|---|---|---|---|
name | String | Full name | "Jan Novák" | |
email | ✓ | String | "jan.novak@example.com" | |
facebook_id | String | Facebook ID | "123456789" | |
date_registered | String | Date and time when customer has been registered in ISO 8601 format | "2013-07-22T14:57:18+00:00" | |
customer_id | String | Unique ID of registered customer | "c9f0f895fb98ab9159f51fd0297e236d" |
Order
| Name | Required | Data type | Value | Example |
|---|---|---|---|---|
order_id | ✓ | String | Unique ID of order | "9JV72FUAC" |
created | ✓ | String | Date and time of order creation in ISO 8601 formar | "2013-07-22T14:57:18+00:00" |
billing_address | ✓ | Address | Billing address of customer | |
delivery_address | Address | Delivery address of customer. Note: If its not specified you billing_address | ||
total_price_vat | ✓ | Number | Total amount of order incl. VAT | 406.07 |
is_paid | ✓ | Boolean | Order has been paid. Orders by Twisto needs is_paid to be set to false. | true |
is_shipped | ✓ | Boolean | Order has been shipped to customer | true |
is_delivered | Boolean | Order has been delivered to customer | true | |
is_returned | Boolean | Order or its part has been returned | false | |
items | ✓ | Array<OrderItem> | Purchased items from order |
Address
| Name | Required | Data type | Value | Example |
|---|---|---|---|---|
name | ✓ | String | Full Name | "Jan Novák" |
street | ✓ | String | Street | "Karla Engliše 3208/5" |
city | ✓ | String | City | "Praha 5" |
zipcode | ✓ | String | Zip code | "15000" |
country | String | Country code in ISO 3166-1 alpha-2 format. Note If not specified, "CZ" will be used instead | "CZ" | |
phones | ✓ | Array<String> | Phone numbers of customer | ["+420733123456", "+420724123456"] or ["+420733123456"] |
Order Item
| Name | Required | Data type | Value | Example |
|---|---|---|---|---|
quantity | ✓ | Number | Quantity | 4 |
name | ✓ | String | Name of goods | "Růžový šátek s ornamenty" |
price_vat | ✓ | Number | Celková cena s DPH [4] | 406.07 |
vat | ✓ | Number | VAT in percentage | 21 |
is_shipment | Boolean | The item represents a shipping fee | false | |
is_payment | Boolean | The item represents the payment fee | false | |
is_discount | Boolean | Item represents discount or rounding item (price_vat must be negative) | false | |
categories | Array<String> | Category tree | ["Laptops", "Apple"] | |
product_id | String | ID of product | "c81e728d9d4c2f636f067f89cc14862c" | |
ean_code | String | EAN code of the product | "8859094127591" |
New Order
| Name | Required | Data type | Value | Example |
|---|---|---|---|---|
total_price_vat | ✓ | Number | Total price incl. VAT | 406.07 |
billing_address | ✓ | Address | Billing address of customer | |
delivery_address | Address | Delivery address of customer. Note: If its not specified you billing_address | ||
items | ✓ | Array<OrderItem> | Individual order items |