Field | Type | Description |
---|---|---|
results | [Order.simple] | Array of Order.simple |
next | Dictionary? | Nullable. Set when we have more results at this moment. It contains the query parameters you need to request the following results. Is null when there are no results left |
future | Dictionary? | Nullable. When all the results have been returned (no next set), but there might be more results in the future, future contains the query parameters you should use to request new results in the future (e.g. in 15 minutes) to know if you have extra results without returning the same results again. |
When used inside a request.
{
"results": [
{
"id": 13,
"status": "PENDING",
"valid": true,
"order_nr": 13,
"prices": {
"price": {
"value": 12,
"currency": "EUR"
},
"discount": {
"value": 13,
"currency": "EUR"
},
"warranty": {
"value": 19,
"currency": "EUR"
},
"delivery_cost": {
"value": 13,
"currency": "EUR"
},
"invoice_cost": {
"value": 16,
"currency": "EUR"
},
"sms_cost": {
"value": 19,
"currency": "EUR"
},
"transaction_cost": {
"value": 11,
"currency": "EUR"
},
"price_to_pay": {
"value": 19,
"currency": "EUR"
},
"price_with_discount": {
"value": 18,
"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": 10,
"comment": "...",
"notification_method": "email"
},
"shop": {
"id": 17,
"name": "Arnaldo Gleichner",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"url": "...",
"allow_order_comments": false,
"allow_product_comments": true,
"allow_order_messages": false,
"global_discount_percentage": 11,
"allow_orders": false,
"currency": "EUR"
},
"created_at": 1657086181,
"joyn": {
"points": 11,
"collect_url": "https://example.com",
"qr_code_url": "https://example.com"
},
"payment_status": "pending",
"currency": "EUR",
"bank_transfer": {
"reference": "...",
"bank_accounts": [
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
}
]
},
"external_order_nr": "...",
"shop_uses_external_order_nrs": false,
"invoice": {
"company": {
"name": "...",
"vat": "BE0123.456.789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
}
},
"referenceCode": "..."
},
{
"id": 19,
"status": "PENDING",
"valid": true,
"order_nr": 16,
"prices": {
"price": {
"value": 15,
"currency": "EUR"
},
"discount": {
"value": 11,
"currency": "EUR"
},
"warranty": {
"value": 10,
"currency": "EUR"
},
"delivery_cost": {
"value": 17,
"currency": "EUR"
},
"invoice_cost": {
"value": 19,
"currency": "EUR"
},
"sms_cost": {
"value": 10,
"currency": "EUR"
},
"transaction_cost": {
"value": 11,
"currency": "EUR"
},
"price_to_pay": {
"value": 15,
"currency": "EUR"
},
"price_with_discount": {
"value": 11,
"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": 15,
"comment": "...",
"notification_method": "email"
},
"shop": {
"id": 12,
"name": "Laverna Quigley",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": true,
"allow_order_messages": false,
"global_discount_percentage": 16,
"allow_orders": false,
"currency": "EUR"
},
"created_at": 1657086181,
"joyn": {
"points": 19,
"collect_url": "https://example.com",
"qr_code_url": "https://example.com"
},
"payment_status": "pending",
"currency": "EUR",
"bank_transfer": {
"reference": "...",
"bank_accounts": [
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
}
]
},
"external_order_nr": "...",
"shop_uses_external_order_nrs": false,
"invoice": {
"company": {
"name": "...",
"vat": "BE0123.456.789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
}
},
"referenceCode": "..."
},
{
"id": 15,
"status": "PENDING",
"valid": true,
"order_nr": 10,
"prices": {
"price": {
"value": 11,
"currency": "EUR"
},
"discount": {
"value": 18,
"currency": "EUR"
},
"warranty": {
"value": 14,
"currency": "EUR"
},
"delivery_cost": {
"value": 15,
"currency": "EUR"
},
"invoice_cost": {
"value": 15,
"currency": "EUR"
},
"sms_cost": {
"value": 11,
"currency": "EUR"
},
"transaction_cost": {
"value": 18,
"currency": "EUR"
},
"price_to_pay": {
"value": 18,
"currency": "EUR"
},
"price_with_discount": {
"value": 10,
"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"
},
"shop": {
"id": 17,
"name": "Desmond Weissnat Sr.",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"url": "...",
"allow_order_comments": false,
"allow_product_comments": true,
"allow_order_messages": true,
"global_discount_percentage": 17,
"allow_orders": true,
"currency": "EUR"
},
"created_at": 1657086181,
"joyn": {
"points": 19,
"collect_url": "https://example.com",
"qr_code_url": "https://example.com"
},
"payment_status": "pending",
"currency": "EUR",
"bank_transfer": {
"reference": "...",
"bank_accounts": [
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
}
]
},
"external_order_nr": "...",
"shop_uses_external_order_nrs": true,
"invoice": {
"company": {
"name": "...",
"vat": "BE0123.456.789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
}
},
"referenceCode": "..."
}
],
"next": {
"status": "PENDING",
"created_after": 1657086181,
"created_before": 1657086181,
"before_id": 12,
"after_id": 10,
"sort": "ascending",
"company_id": 12
},
"future": {
"status": "PENDING",
"created_after": 1657086181,
"created_before": 1657086181,
"before_id": 13,
"after_id": 19,
"sort": "ascending",
"company_id": 11
}
}
When returned in a response.
{
"results": [
{
"id": 12,
"status": "PENDING",
"valid": false,
"order_nr": 15,
"prices": {
"price": {
"value": 11,
"currency": "EUR"
},
"discount": {
"value": 18,
"currency": "EUR"
},
"warranty": {
"value": 18,
"currency": "EUR"
},
"delivery_cost": {
"value": 11,
"currency": "EUR"
},
"invoice_cost": {
"value": 10,
"currency": "EUR"
},
"sms_cost": {
"value": 14,
"currency": "EUR"
},
"transaction_cost": {
"value": 16,
"currency": "EUR"
},
"price_to_pay": {
"value": 12,
"currency": "EUR"
},
"price_with_discount": {
"value": 15,
"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"
},
"shop": {
"id": 17,
"name": "Kathryne Morar",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": false,
"allow_order_messages": false,
"global_discount_percentage": 13,
"allow_orders": false,
"currency": "EUR"
},
"created_at": 1657086181,
"joyn": {
"points": 14,
"collect_url": "https://example.com",
"qr_code_url": "https://example.com"
},
"payment_status": "pending",
"currency": "EUR",
"bank_transfer": {
"reference": "...",
"bank_accounts": [
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
}
]
},
"external_order_nr": "...",
"shop_uses_external_order_nrs": false,
"invoice": {
"company": {
"name": "...",
"vat": "BE0123.456.789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
}
},
"referenceCode": "..."
},
{
"id": 17,
"status": "PENDING",
"valid": false,
"order_nr": 18,
"prices": {
"price": {
"value": 19,
"currency": "EUR"
},
"discount": {
"value": 14,
"currency": "EUR"
},
"warranty": {
"value": 16,
"currency": "EUR"
},
"delivery_cost": {
"value": 18,
"currency": "EUR"
},
"invoice_cost": {
"value": 14,
"currency": "EUR"
},
"sms_cost": {
"value": 10,
"currency": "EUR"
},
"transaction_cost": {
"value": 13,
"currency": "EUR"
},
"price_to_pay": {
"value": 11,
"currency": "EUR"
},
"price_with_discount": {
"value": 18,
"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"
},
"shop": {
"id": 15,
"name": "Glennie Boehm",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"url": "...",
"allow_order_comments": false,
"allow_product_comments": false,
"allow_order_messages": true,
"global_discount_percentage": 19,
"allow_orders": false,
"currency": "EUR"
},
"created_at": 1657086181,
"joyn": {
"points": 10,
"collect_url": "https://example.com",
"qr_code_url": "https://example.com"
},
"payment_status": "pending",
"currency": "EUR",
"bank_transfer": {
"reference": "...",
"bank_accounts": [
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
}
]
},
"external_order_nr": "...",
"shop_uses_external_order_nrs": false,
"invoice": {
"company": {
"name": "...",
"vat": "BE0123.456.789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
}
},
"referenceCode": "..."
},
{
"id": 17,
"status": "PENDING",
"valid": true,
"order_nr": 19,
"prices": {
"price": {
"value": 15,
"currency": "EUR"
},
"discount": {
"value": 14,
"currency": "EUR"
},
"warranty": {
"value": 10,
"currency": "EUR"
},
"delivery_cost": {
"value": 13,
"currency": "EUR"
},
"invoice_cost": {
"value": 18,
"currency": "EUR"
},
"sms_cost": {
"value": 14,
"currency": "EUR"
},
"transaction_cost": {
"value": 16,
"currency": "EUR"
},
"price_to_pay": {
"value": 16,
"currency": "EUR"
},
"price_with_discount": {
"value": 16,
"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"
},
"shop": {
"id": 11,
"name": "Providenci Kreiger",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": true,
"allow_order_messages": false,
"global_discount_percentage": 13,
"allow_orders": false,
"currency": "EUR"
},
"created_at": 1657086181,
"joyn": {
"points": 11,
"collect_url": "https://example.com",
"qr_code_url": "https://example.com"
},
"payment_status": "pending",
"currency": "EUR",
"bank_transfer": {
"reference": "...",
"bank_accounts": [
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
},
{
"bank": "ING. Bank",
"number": "BE283578529348"
}
]
},
"external_order_nr": "...",
"shop_uses_external_order_nrs": false,
"invoice": {
"company": {
"name": "...",
"vat": "BE0123.456.789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
}
},
"referenceCode": "..."
}
],
"next": {
"status": "PENDING",
"created_after": 1657086181,
"created_before": 1657086181,
"before_id": 16,
"after_id": 14,
"sort": "ascending",
"company_id": 16
},
"future": {
"status": "PENDING",
"created_after": 1657086181,
"created_before": 1657086181,
"before_id": 16,
"after_id": 10,
"sort": "ascending",
"company_id": 13
}
}