| 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 | Prices | 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 | Checkout.Company? | 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). |
When used inside a request.
{
"id": 10,
"shop_id": 11,
"company_id": 16,
"status": "PENDING",
"order_nr": 14,
"prices": {
"price": 18,
"discount": 16,
"warranty": 13,
"delivery_cost": 11,
"invoice_cost": 16,
"sms_cost": 11,
"transaction_cost": 17,
"price_to_pay": 14
},
"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
},
"products": [
[],
[],
[]
],
"invoice": {
"name": "...",
"vat": "BE0123456789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
},
"isop": {
"origin": "in-store",
"customer_id": 16,
"employee_id": 18
},
"consumer": {
"email": "example@domain.com",
"firstname": "...",
"lastname": "...",
"phone": "+32 475 00 00 00"
},
"created_at": 1657086098
}When returned in a response.
{
"id": 16,
"shop_id": 18,
"company_id": 15,
"status": "PENDING",
"order_nr": 11,
"prices": {
"price": 17,
"discount": 14,
"warranty": 11,
"delivery_cost": 14,
"invoice_cost": 14,
"sms_cost": 18,
"transaction_cost": 11,
"price_to_pay": 10
},
"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": 13
},
"products": [
{
"amount": 11,
"persons": 17,
"gram": 19,
"comment": "...",
"product": {
"id": 13,
"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": 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": false
}
],
"price_type": "PER_UNIT",
"target_price": true,
"price": 19
},
"product_price": {
"id": 14,
"name": "...",
"price": 19
},
"calculated_prices": {
"unit_price": 12,
"price": 16
},
"discount_prices": {
"unit_price": 16,
"price": 12
},
"options": [
{
"id": 11,
"name": "...",
"price_change": 11,
"optionset": {
"id": 13,
"name": "...",
"allow_attachment": true
}
},
{
"id": 16,
"name": "...",
"price_change": 11,
"optionset": {
"id": 17,
"name": "...",
"allow_attachment": true
}
},
{
"id": 18,
"name": "...",
"price_change": 10,
"optionset": {
"id": 12,
"name": "...",
"allow_attachment": true
}
}
],
"uploads": [
{
"upload": {
"id": 16,
"url": "https://example.com"
},
"optionset_id": 15
},
{
"upload": {
"id": 14,
"url": "https://example.com"
},
"optionset_id": 14
},
{
"upload": {
"id": 13,
"url": "https://example.com"
},
"optionset_id": 14
}
],
"code": "..."
},
{
"amount": 19,
"persons": 15,
"gram": 17,
"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": 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
},
{
"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": false,
"price": 12
},
"product_price": {
"id": 10,
"name": "...",
"price": 10
},
"calculated_prices": {
"unit_price": 15,
"price": 16
},
"discount_prices": {
"unit_price": 18,
"price": 14
},
"options": [
{
"id": 14,
"name": "...",
"price_change": 17,
"optionset": {
"id": 12,
"name": "...",
"allow_attachment": true
}
},
{
"id": 15,
"name": "...",
"price_change": 14,
"optionset": {
"id": 10,
"name": "...",
"allow_attachment": false
}
},
{
"id": 10,
"name": "...",
"price_change": 13,
"optionset": {
"id": 11,
"name": "...",
"allow_attachment": true
}
}
],
"uploads": [
{
"upload": {
"id": 16,
"url": "https://example.com"
},
"optionset_id": 14
},
{
"upload": {
"id": 17,
"url": "https://example.com"
},
"optionset_id": 11
},
{
"upload": {
"id": 12,
"url": "https://example.com"
},
"optionset_id": 12
}
],
"code": "..."
},
{
"amount": 13,
"persons": 12,
"gram": 14,
"comment": "...",
"product": {
"id": 12,
"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": true
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": 18
},
"product_price": {
"id": 16,
"name": "...",
"price": 14
},
"calculated_prices": {
"unit_price": 17,
"price": 18
},
"discount_prices": {
"unit_price": 14,
"price": 10
},
"options": [
{
"id": 17,
"name": "...",
"price_change": 19,
"optionset": {
"id": 17,
"name": "...",
"allow_attachment": true
}
},
{
"id": 14,
"name": "...",
"price_change": 10,
"optionset": {
"id": 19,
"name": "...",
"allow_attachment": false
}
},
{
"id": 16,
"name": "...",
"price_change": 10,
"optionset": {
"id": 15,
"name": "...",
"allow_attachment": false
}
}
],
"uploads": [
{
"upload": {
"id": 16,
"url": "https://example.com"
},
"optionset_id": 17
},
{
"upload": {
"id": 19,
"url": "https://example.com"
},
"optionset_id": 10
},
{
"upload": {
"id": 12,
"url": "https://example.com"
},
"optionset_id": 16
}
],
"code": "..."
}
],
"invoice": {
"name": "...",
"vat": "BE0123456789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
},
"isop": {
"origin": "in-store",
"customer_id": 17,
"employee_id": 19
},
"consumer": {
"email": "example@domain.com",
"firstname": "...",
"lastname": "...",
"phone": "+32 475 00 00 00"
},
"created_at": 1657086098
}