Field | Type | Description |
---|---|---|
id | Int | Id of the product |
status | String | String enumarion of 'PENDING', 'HAS_READ', 'APPROVED', 'DECLINED', 'REMOVED', 'DELETED_BY_SHOP', 'COLLECTED' |
valid | Bool | Is true when the order is completed or paid and visible for the shop. |
order_nr | Int | Unique number on a yearly basis and per shop. Visible for the shop and users. Only available for valid orders. |
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', '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', 'pesopay_gcash', 'pesopay_visa', 'pesopay_mc' |
checkout | OrderCheckout | |
shop | Shop.simple | |
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). |
joyn | Joyn? | Nullable. Contains the amount of points that can get saved with Joyn + a link to collect the points. |
payment_status | String? | Nullable. String enumarion of 'pending', 'canceled', 'timeout', 'declined', 'refunded', 'paid' |
currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 134,
"status": "REMOVED",
"valid": true,
"order_nr": 58,
"prices": {
"price": {
"value": 13710,
"currency": "EUR"
},
"discount": {
"value": 0,
"currency": "EUR"
},
"warranty": {
"value": 0,
"currency": "EUR"
},
"delivery_cost": {
"value": 0,
"currency": "EUR"
},
"invoice_cost": {
"value": 0,
"currency": "EUR"
},
"sms_cost": {
"value": 0,
"currency": "EUR"
},
"transaction_cost": {
"value": 0,
"currency": "EUR"
},
"price_to_pay": {
"value": 13710,
"currency": "EUR"
}
},
"payment_method": "stripe_card_visa_mc",
"checkout": {
"method": "takeout",
"date": "2017-12-30",
"time": "17:38"
},
"created_at": 1617183164,
"shop": {
"id": 315,
"name": "Best Thing Since Sliced Bread",
"address": {
"street": "Amraniring",
"nr": "91",
"zipcode": "6870",
"city": "Tienen",
"country": "BE",
"position": {
"latitude": 51.260197,
"longitude": 4.402771
}
},
"allow_comments": false,
"currency": "EUR"
},
"payment_status": null,
"joyn": null,
"currency": "EUR"
}
{
"id": 136,
"status": "DELETED_BY_SHOP",
"valid": true,
"order_nr": 59,
"prices": {
"price": {
"value": 15926,
"currency": "EUR"
},
"discount": {
"value": 0,
"currency": "EUR"
},
"warranty": {
"value": 0,
"currency": "EUR"
},
"delivery_cost": {
"value": 0,
"currency": "EUR"
},
"invoice_cost": {
"value": 0,
"currency": "EUR"
},
"sms_cost": {
"value": 0,
"currency": "EUR"
},
"transaction_cost": {
"value": 0,
"currency": "EUR"
},
"price_to_pay": {
"value": 15926,
"currency": "EUR"
}
},
"payment_method": "payu_brazil_diners",
"checkout": {
"method": "delivery",
"date": "2021-12-22",
"time": "08:41",
"end_time": "08:56",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Ghent",
"country": "BE"
},
"notes": null
},
"created_at": 1617183166,
"shop": {
"id": 317,
"name": "Ahead of Bread",
"address": {
"street": "Baertsingel",
"nr": "32",
"zipcode": "8580",
"city": "Dendermonde",
"country": "BE",
"position": {
"latitude": 51.260197,
"longitude": 4.402771
}
},
"allow_comments": false,
"currency": "EUR"
},
"payment_status": null,
"joyn": null,
"currency": "EUR"
}
{
"id": 138,
"status": "HAS_READ",
"valid": true,
"order_nr": 60,
"prices": {
"price": {
"value": 13066,
"currency": "EUR"
},
"discount": {
"value": 0,
"currency": "EUR"
},
"warranty": {
"value": 0,
"currency": "EUR"
},
"delivery_cost": {
"value": 0,
"currency": "EUR"
},
"invoice_cost": {
"value": 0,
"currency": "EUR"
},
"sms_cost": {
"value": 0,
"currency": "EUR"
},
"transaction_cost": {
"value": 0,
"currency": "EUR"
},
"price_to_pay": {
"value": 13066,
"currency": "EUR"
}
},
"payment_method": "payu_romania_visa",
"checkout": {
"method": "latch",
"date": "2020-02-28",
"time": "06:21",
"latch_id": 41,
"name": "Clara Louis",
"address": {
"street": "Petitsingel",
"nr": "51",
"zipcode": "7800",
"city": "Bouillon",
"country": "BE"
}
},
"created_at": 1617183167,
"shop": {
"id": 319,
"name": "Bakers Delight",
"address": {
"street": "Mertenssteeg",
"nr": "68",
"zipcode": "6717",
"city": "La Louvière",
"country": "BE",
"position": {
"latitude": 50.8503396,
"longitude": 4.3517103
}
},
"allow_comments": false,
"currency": "EUR"
},
"payment_status": null,
"joyn": null,
"currency": "EUR"
}
When returned in a response.
{
"id": 140,
"status": "PENDING",
"valid": true,
"order_nr": 61,
"prices": {
"price": {
"value": 6908,
"currency": "EUR"
},
"discount": {
"value": 0,
"currency": "EUR"
},
"warranty": {
"value": 0,
"currency": "EUR"
},
"delivery_cost": {
"value": 0,
"currency": "EUR"
},
"invoice_cost": {
"value": 0,
"currency": "EUR"
},
"sms_cost": {
"value": 0,
"currency": "EUR"
},
"transaction_cost": {
"value": 0,
"currency": "EUR"
},
"price_to_pay": {
"value": 6908,
"currency": "EUR"
}
},
"payment_method": "payu_sp_pbl",
"checkout": {
"method": "takeout",
"date": "2022-09-10",
"time": "19:07"
},
"created_at": 1617183168,
"shop": {
"id": 321,
"name": "Irresistible Indulgence",
"address": {
"street": "Jacquetsteeg",
"nr": "77",
"zipcode": "6860",
"city": "Fleurus",
"country": "BE",
"position": {
"latitude": 51.260197,
"longitude": 4.402771
}
},
"allow_comments": false,
"currency": "EUR"
},
"payment_status": null,
"joyn": null,
"currency": "EUR"
}
{
"id": 142,
"status": "COLLECTED",
"valid": true,
"order_nr": 62,
"prices": {
"price": {
"value": 14906,
"currency": "EUR"
},
"discount": {
"value": 0,
"currency": "EUR"
},
"warranty": {
"value": 0,
"currency": "EUR"
},
"delivery_cost": {
"value": 0,
"currency": "EUR"
},
"invoice_cost": {
"value": 0,
"currency": "EUR"
},
"sms_cost": {
"value": 0,
"currency": "EUR"
},
"transaction_cost": {
"value": 0,
"currency": "EUR"
},
"price_to_pay": {
"value": 14906,
"currency": "EUR"
}
},
"payment_method": "payu_brazil_elo",
"checkout": {
"method": "delivery",
"date": "2016-10-13",
"time": "15:10",
"end_time": "15:25",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Ghent",
"country": "BE"
},
"notes": null
},
"created_at": 1617183169,
"shop": {
"id": 323,
"name": "Sensational Goodies",
"address": {
"street": "Brasseurbaan",
"nr": "83",
"zipcode": "5300",
"city": "Harelbeke",
"country": "BE",
"position": {
"latitude": 50.8503396,
"longitude": 4.3517103
}
},
"allow_comments": false,
"currency": "EUR"
},
"payment_status": null,
"joyn": null,
"currency": "EUR"
}
{
"id": 144,
"status": "DECLINED",
"valid": true,
"order_nr": 63,
"prices": {
"price": {
"value": 7055,
"currency": "EUR"
},
"discount": {
"value": 0,
"currency": "EUR"
},
"warranty": {
"value": 0,
"currency": "EUR"
},
"delivery_cost": {
"value": 0,
"currency": "EUR"
},
"invoice_cost": {
"value": 0,
"currency": "EUR"
},
"sms_cost": {
"value": 0,
"currency": "EUR"
},
"transaction_cost": {
"value": 0,
"currency": "EUR"
},
"price_to_pay": {
"value": 7055,
"currency": "EUR"
}
},
"payment_method": "point_of_sale",
"checkout": {
"method": "latch",
"date": "2023-06-17",
"time": "07:25",
"latch_id": 43,
"name": "Lise Verhelst",
"address": {
"street": "Evrardsteeg",
"nr": "74",
"zipcode": "8700",
"city": "Beauraing",
"country": "BE"
}
},
"created_at": 1617183171,
"shop": {
"id": 325,
"name": "Cake Bakes",
"address": {
"street": "Jacqueslaan",
"nr": "60",
"zipcode": "8570",
"city": "Aat",
"country": "BE",
"position": {
"latitude": 50.8503396,
"longitude": 4.3517103
}
},
"allow_comments": false,
"currency": "EUR"
},
"payment_status": null,
"joyn": null,
"currency": "EUR"
}