| Field | Type | Description |
|---|---|---|
| id | Int | Id of the product |
| shop_id | Int | Id of the shop where this order has been placed |
| company_id | Int | Id of the company of the shop where this order has been placed |
| status | String | String enumarion of 'PENDING', 'HAS_READ', 'APPROVED', 'DECLINED', 'REMOVED', 'DELETED_BY_SHOP', 'COLLECTED' |
| order_nr | Int | Unique number on a yearly basis and per shop. Visible for the shop and consumers. |
| prices | CartPrices | Prices |
| payment_method | String | String enumarion of 'point_of_sale', 'paid_in_shop', 'bank_transfer', 'ideal', 'bancontact', 'sofort', 'giropay', 'creditcard', 'cartes_bancaires', 'paypal', 'eps_uberweisung', 'apple_pay', 'google_pay', 'payconiq', 'monizze', 'edenred', 'webpay', 'credomatic', 'satispay', 'stripe_card_visa_mc', 'stripe_card_amex', 'stripe_apple_pay', 'stripe_google_pay', 'payu_romania_visa', 'payu_romania_mc', 'payu_romania_visa_electron', 'payu_romania_maestro', 'payu_brazil_amex', 'payu_brazil_boleto_bancario', 'payu_brazil_diners', 'payu_brazil_elo', 'payu_brazil_hipercard', 'payu_brazil_mc', 'payu_brazil_visa', 'payu_sp_maestro', 'payu_sp_mc', 'payu_sp_pbl', 'payu_sp_visa', 'payu_sp_blik', 'payu_iyzico_amex', 'payu_iyzico_mc', 'payu_iyzico_troy', 'payu_iyzico_visa', 'pesopay_gcash', 'pesopay_visa', 'pesopay_mc', 'redsys_bizum', 'sibs_id' |
| checkout | OrderCheckout | |
| products | [CartItem.company] | A list of all the products that have been ordered. Please note that the product data (prices, name, options...) can differ from the current product data because the data of products are captured at the time of placing the order to prevent product changes to affect existing orders. |
| invoice | company.OrderInvoice? | Nullable. When the consumer requested an invoice, this value will contain all the invoice details. |
| isop | Checkout.ISOP? | Nullable. When this order has been placed with the ISOP module, it will contain all the isop details. |
| consumer | company.Consumer? | Nullable. Contains some information about the user that placed the order. It may not be available when the data had to be removed for GDPR compliance. |
| created_at | Timestamp | Time when the order was created, measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT). |
| external_order_nr | String | External order nr assigned by a POS or other 3rd party software |
| shop_uses_external_order_nrs | Bool | Whether or not the shop assigns external order nrs to orders |
| note_to_self | String | Optional. A String value |
| warranty | Dictionary | Optional. A dictionary with fields |
| source | String | Optional. A String value |
| tin_nr | String | Optional. A String value |
| preparation_status | String? | Optional. Nullable. String enumarion of 'PREPARING', 'READY' |
When used inside a request.
{
"id": 18,
"shop_id": 10,
"company_id": 13,
"status": "PENDING",
"order_nr": 15,
"prices": {
"price": {
"value": 19,
"currency": "EUR"
},
"discount": {
"value": 15,
"currency": "EUR"
},
"warranty": {
"value": 16,
"currency": "EUR"
},
"delivery_cost": {
"value": 12,
"currency": "EUR"
},
"invoice_cost": {
"value": 15,
"currency": "EUR"
},
"sms_cost": {
"value": 11,
"currency": "EUR"
},
"transaction_cost": {
"value": 18,
"currency": "EUR"
},
"price_to_pay": {
"value": 17,
"currency": "EUR"
},
"price_with_discount": {
"value": 13,
"currency": "EUR"
}
},
"payment_method": "point_of_sale",
"checkout": {
"method": "delivery",
"date": "2019-01-31",
"time": "12:00",
"end_time": "12:00",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"notes": "...",
"name": "...",
"latch_id": 18,
"comment": "...",
"notification_method": "email"
},
"products": [
[],
[],
[]
],
"invoice": {
"name": "...",
"vat": "...",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"generated": true
},
"isop": {
"origin": "in-store",
"customer_id": 10,
"employee_id": 13
},
"consumer": {
"email": "example@domain.com",
"firstname": "...",
"lastname": "...",
"phone": "+32 475 00 00 00",
"user_id": 16
},
"created_at": 1657085959,
"external_order_nr": "...",
"shop_uses_external_order_nrs": false,
"note_to_self": "...",
"warranty": {
"cost": 9.67,
"bankAccountNr": "...",
"returned": true,
"refunded": false
},
"source": "...",
"tin_nr": "...",
"preparation_status": "PREPARING"
}When returned in a response.
{
"id": 14,
"shop_id": 13,
"company_id": 12,
"status": "PENDING",
"order_nr": 11,
"prices": {
"price": {
"value": 15,
"currency": "EUR"
},
"discount": {
"value": 13,
"currency": "EUR"
},
"warranty": {
"value": 15,
"currency": "EUR"
},
"delivery_cost": {
"value": 15,
"currency": "EUR"
},
"invoice_cost": {
"value": 17,
"currency": "EUR"
},
"sms_cost": {
"value": 14,
"currency": "EUR"
},
"transaction_cost": {
"value": 16,
"currency": "EUR"
},
"price_to_pay": {
"value": 18,
"currency": "EUR"
},
"price_with_discount": {
"value": 13,
"currency": "EUR"
}
},
"payment_method": "point_of_sale",
"checkout": {
"method": "delivery",
"date": "2019-01-31",
"time": "12:00",
"end_time": "12:00",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"notes": "...",
"name": "...",
"latch_id": 12,
"comment": "...",
"notification_method": "email"
},
"products": [
{
"amount": 13,
"persons": 15,
"gram": 12,
"comment": "...",
"product": {
"id": 19,
"name": "...",
"images": [
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": {
"value": 19,
"currency": "EUR"
},
"only_order_in_store": true,
"price_look_up_code": "...",
"code": "...",
"category": {
"id": 15,
"name": "..."
},
"origin": "..."
},
"product_price": {
"id": 14,
"name": "...",
"price": {
"value": 11,
"currency": "EUR"
},
"price_look_up_code": "...",
"code": "..."
},
"calculated_prices": {
"unit_price": {
"value": 14,
"currency": "EUR"
},
"price": {
"value": 17,
"currency": "EUR"
}
},
"discount_prices": {
"unit_price": {
"value": 13,
"currency": "EUR"
},
"price": {
"value": 10,
"currency": "EUR"
}
},
"amount_free": 17,
"options": [
{
"option": {
"id": 13,
"name": "...",
"price_change": {
"value": 13,
"currency": "EUR"
},
"image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 18,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": true,
"min_different_options": 18,
"max_different_options": 11,
"min_amount_options": 14,
"max_amount_options": 12
}
},
"upload": {
"id": 12,
"url": "https://example.com"
},
"amount": 13
},
{
"option": {
"id": 18,
"name": "...",
"price_change": {
"value": 12,
"currency": "EUR"
},
"image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 14,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 18,
"max_different_options": 15,
"min_amount_options": 13,
"max_amount_options": 11
}
},
"upload": {
"id": 13,
"url": "https://example.com"
},
"amount": 16
},
{
"option": {
"id": 15,
"name": "...",
"price_change": {
"value": 11,
"currency": "EUR"
},
"image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 18,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 13,
"max_different_options": 11,
"min_amount_options": 10,
"max_amount_options": 16
}
},
"upload": {
"id": 17,
"url": "https://example.com"
},
"amount": 12
}
]
},
{
"amount": 13,
"persons": 15,
"gram": 13,
"comment": "...",
"product": {
"id": 17,
"name": "...",
"images": [
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
}
],
"price_type": "PER_UNIT",
"target_price": true,
"price": {
"value": 19,
"currency": "EUR"
},
"only_order_in_store": false,
"price_look_up_code": "...",
"code": "...",
"category": {
"id": 13,
"name": "..."
},
"origin": "..."
},
"product_price": {
"id": 12,
"name": "...",
"price": {
"value": 17,
"currency": "EUR"
},
"price_look_up_code": "...",
"code": "..."
},
"calculated_prices": {
"unit_price": {
"value": 19,
"currency": "EUR"
},
"price": {
"value": 15,
"currency": "EUR"
}
},
"discount_prices": {
"unit_price": {
"value": 15,
"currency": "EUR"
},
"price": {
"value": 14,
"currency": "EUR"
}
},
"amount_free": 18,
"options": [
{
"option": {
"id": 18,
"name": "...",
"price_change": {
"value": 18,
"currency": "EUR"
},
"image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 12,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 18,
"max_different_options": 17,
"min_amount_options": 13,
"max_amount_options": 14
}
},
"upload": {
"id": 13,
"url": "https://example.com"
},
"amount": 11
},
{
"option": {
"id": 10,
"name": "...",
"price_change": {
"value": 16,
"currency": "EUR"
},
"image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 11,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 16,
"max_different_options": 17,
"min_amount_options": 12,
"max_amount_options": 17
}
},
"upload": {
"id": 19,
"url": "https://example.com"
},
"amount": 17
},
{
"option": {
"id": 10,
"name": "...",
"price_change": {
"value": 11,
"currency": "EUR"
},
"image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 19,
"name": "...",
"code": "...",
"multiple_choice": false,
"choose_amount": true,
"min_different_options": 10,
"max_different_options": 17,
"min_amount_options": 14,
"max_amount_options": 12
}
},
"upload": {
"id": 19,
"url": "https://example.com"
},
"amount": 17
}
]
},
{
"amount": 11,
"persons": 12,
"gram": 13,
"comment": "...",
"product": {
"id": 18,
"name": "...",
"images": [
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
}
],
"price_type": "PER_UNIT",
"target_price": true,
"price": {
"value": 13,
"currency": "EUR"
},
"only_order_in_store": true,
"price_look_up_code": "...",
"code": "...",
"category": {
"id": 18,
"name": "..."
},
"origin": "..."
},
"product_price": {
"id": 10,
"name": "...",
"price": {
"value": 12,
"currency": "EUR"
},
"price_look_up_code": "...",
"code": "..."
},
"calculated_prices": {
"unit_price": {
"value": 10,
"currency": "EUR"
},
"price": {
"value": 10,
"currency": "EUR"
}
},
"discount_prices": {
"unit_price": {
"value": 12,
"currency": "EUR"
},
"price": {
"value": 17,
"currency": "EUR"
}
},
"amount_free": 16,
"options": [
{
"option": {
"id": 12,
"name": "...",
"price_change": {
"value": 10,
"currency": "EUR"
},
"image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 15,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": true,
"min_different_options": 10,
"max_different_options": 10,
"min_amount_options": 12,
"max_amount_options": 17
}
},
"upload": {
"id": 16,
"url": "https://example.com"
},
"amount": 10
},
{
"option": {
"id": 17,
"name": "...",
"price_change": {
"value": 19,
"currency": "EUR"
},
"image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 18,
"name": "...",
"code": "...",
"multiple_choice": true,
"choose_amount": false,
"min_different_options": 13,
"max_different_options": 12,
"min_amount_options": 18,
"max_amount_options": 13
}
},
"upload": {
"id": 11,
"url": "https://example.com"
},
"amount": 12
},
{
"option": {
"id": 19,
"name": "...",
"price_change": {
"value": 18,
"currency": "EUR"
},
"image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 12,
"name": "...",
"code": "...",
"multiple_choice": false,
"choose_amount": true,
"min_different_options": 12,
"max_different_options": 10,
"min_amount_options": 18,
"max_amount_options": 16
}
},
"upload": {
"id": 12,
"url": "https://example.com"
},
"amount": 14
}
]
}
],
"invoice": {
"id": 15,
"name": "...",
"vat": "...",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"generated": false
},
"isop": {
"origin": "in-store",
"customer_id": 16,
"employee_id": 19
},
"consumer": {
"email": "example@domain.com",
"firstname": "...",
"lastname": "...",
"phone": "+32 475 00 00 00",
"user_id": 16
},
"created_at": 1657085959,
"external_order_nr": "...",
"shop_uses_external_order_nrs": true,
"note_to_self": "...",
"warranty": {
"cost": 9.67,
"bankAccountNr": "...",
"returned": false,
"refunded": false
},
"source": "...",
"tin_nr": "...",
"preparation_status": "PREPARING"
}