GET /company/shops/@id/orders
Return all orders (sorted from old to new by default). You can filter the results. If you want to poll for new orders, you should use the future property:
next value from the API, do immediately another call with the next query parameters when you finished processing the orders in resultsnext value and you received a non-null future property, then there are no new orders available right now but there might be in the future. Store the future property somewhere persistent (keep it after a reboot).future property to the backend and then the backend will give us the new orders together with a next or future propertyThe future object will only be available if it is possible that new orders will match your filtering criteria, when you use ascending sorting (default), and if there are no more results left (next property is null, results may stil contain some orders).
This endpoint requires authentication.
| Header | Value |
|---|---|
| Authorization | Set the value to Bearer + + access_token |
Replace the @ keywords in the URL with their corresponding value.
A dictionary with fields
| Field | Type | Description |
|---|---|---|
| id | Int | The id of the shop you are requesting to get the orders from |
Append the querystring with following properties to the URL.
A dictionary with fields
| Field | Type | Description |
|---|---|---|
| status | String | Optional. Only return orders with this status |
| created_after | DateTime | Optional. Only return orders that were placed after (including) this date/time. Brussels timezone. Do not use this for pagination as multiple orders might share the same created_at timestamp. |
| created_before | DateTime | Optional. Only return orders that were placed before (including) this date/time. Brussels timezone. You can use this together with created_after. Do not use this for pagination as multiple orders might share the same created_at timestamp. |
| before_id | Int | Optional. Only return orders created before (not including) the order with the given id. Used for pagination. |
| after_id | Int | Optional. Only return orders created after (not including) the order with the given id. Used for pagination. |
| sort | String | Optional. Sort the results in ascending (default) or descending order by creation date. Default is ascending. |
GET /company/shops/10/orders?status=PENDING&created_after=2019-01-31+12%3A00%3A00&created_before=2019-01-31+12%3A00%3A00&before_id=11&after_id=15&sort=ascending HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.2.2
Accept-Language: en-US,en;q=0.5
| Field | Type | Description |
|---|---|---|
| results | [company.Order.detailed] | Array of company.Order.detailed |
| next | Dictionary? | Nullable. The query parameters you need to request the following results. Is null when there are no results left |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 59767
{
"results": [
{
"id": 15,
"shop_id": 16,
"company_id": 12,
"status": "PENDING",
"order_nr": 17,
"prices": {
"price": 19,
"discount": 16,
"warranty": 16,
"delivery_cost": 12,
"invoice_cost": 15,
"sms_cost": 18,
"transaction_cost": 12,
"price_to_pay": 19
},
"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": "..."
},
"products": [
{
"amount": 12,
"persons": 18,
"gram": 18,
"comment": "...",
"product": {
"id": 11,
"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": true
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": 19
},
"product_price": {
"id": 16,
"name": "...",
"price": 17
},
"calculated_prices": {
"unit_price": 11,
"price": 18
},
"discount_prices": {
"unit_price": 10,
"price": 16
},
"options": [
{
"id": 16,
"name": "...",
"price_change": 19,
"optionset": {
"id": 10,
"name": "...",
"allow_attachment": true
}
},
{
"id": 11,
"name": "...",
"price_change": 15,
"optionset": {
"id": 17,
"name": "...",
"allow_attachment": true
}
},
{
"id": 10,
"name": "...",
"price_change": 16,
"optionset": {
"id": 15,
"name": "...",
"allow_attachment": false
}
}
],
"uploads": [
{
"upload": {
"id": 12,
"url": "https://example.com"
},
"optionset_id": 18
},
{
"upload": {
"id": 16,
"url": "https://example.com"
},
"optionset_id": 17
},
{
"upload": {
"id": 19,
"url": "https://example.com"
},
"optionset_id": 11
}
],
"code": "..."
},
{
"amount": 16,
"persons": 15,
"gram": 11,
"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": 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": true,
"price": 13
},
"product_price": {
"id": 15,
"name": "...",
"price": 15
},
"calculated_prices": {
"unit_price": 13,
"price": 11
},
"discount_prices": {
"unit_price": 15,
"price": 13
},
"options": [
{
"id": 13,
"name": "...",
"price_change": 13,
"optionset": {
"id": 10,
"name": "...",
"allow_attachment": true
}
},
{
"id": 18,
"name": "...",
"price_change": 10,
"optionset": {
"id": 15,
"name": "...",
"allow_attachment": false
}
},
{
"id": 14,
"name": "...",
"price_change": 11,
"optionset": {
"id": 11,
"name": "...",
"allow_attachment": true
}
}
],
"uploads": [
{
"upload": {
"id": 16,
"url": "https://example.com"
},
"optionset_id": 13
},
{
"upload": {
"id": 17,
"url": "https://example.com"
},
"optionset_id": 12
},
{
"upload": {
"id": 12,
"url": "https://example.com"
},
"optionset_id": 10
}
],
"code": "..."
},
{
"amount": 16,
"persons": 13,
"gram": 14,
"comment": "...",
"product": {
"id": 11,
"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": 15
},
"product_price": {
"id": 12,
"name": "...",
"price": 19
},
"calculated_prices": {
"unit_price": 16,
"price": 10
},
"discount_prices": {
"unit_price": 13,
"price": 18
},
"options": [
{
"id": 18,
"name": "...",
"price_change": 17,
"optionset": {
"id": 17,
"name": "...",
"allow_attachment": false
}
},
{
"id": 15,
"name": "...",
"price_change": 19,
"optionset": {
"id": 15,
"name": "...",
"allow_attachment": false
}
},
{
"id": 18,
"name": "...",
"price_change": 17,
"optionset": {
"id": 14,
"name": "...",
"allow_attachment": false
}
}
],
"uploads": [
{
"upload": {
"id": 19,
"url": "https://example.com"
},
"optionset_id": 18
},
{
"upload": {
"id": 11,
"url": "https://example.com"
},
"optionset_id": 18
},
{
"upload": {
"id": 15,
"url": "https://example.com"
},
"optionset_id": 10
}
],
"code": "..."
}
],
"invoice": {
"name": "...",
"vat": "BE0123456789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
},
"isop": {
"origin": "in-store",
"customer_id": 14,
"employee_id": 17
},
"consumer": {
"email": "example@domain.com",
"firstname": "...",
"lastname": "...",
"phone": "+32 475 00 00 00"
},
"created_at": "2019-01-31 12:00:00"
},
{
"id": 18,
"shop_id": 15,
"company_id": 12,
"status": "PENDING",
"order_nr": 16,
"prices": {
"price": 10,
"discount": 16,
"warranty": 11,
"delivery_cost": 14,
"invoice_cost": 17,
"sms_cost": 19,
"transaction_cost": 13,
"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": "..."
},
"products": [
{
"amount": 11,
"persons": 14,
"gram": 18,
"comment": "...",
"product": {
"id": 10,
"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": 13
},
"product_price": {
"id": 16,
"name": "...",
"price": 11
},
"calculated_prices": {
"unit_price": 11,
"price": 18
},
"discount_prices": {
"unit_price": 17,
"price": 17
},
"options": [
{
"id": 16,
"name": "...",
"price_change": 14,
"optionset": {
"id": 15,
"name": "...",
"allow_attachment": true
}
},
{
"id": 13,
"name": "...",
"price_change": 17,
"optionset": {
"id": 13,
"name": "...",
"allow_attachment": true
}
},
{
"id": 18,
"name": "...",
"price_change": 16,
"optionset": {
"id": 12,
"name": "...",
"allow_attachment": true
}
}
],
"uploads": [
{
"upload": {
"id": 15,
"url": "https://example.com"
},
"optionset_id": 16
},
{
"upload": {
"id": 14,
"url": "https://example.com"
},
"optionset_id": 19
},
{
"upload": {
"id": 12,
"url": "https://example.com"
},
"optionset_id": 12
}
],
"code": "..."
},
{
"amount": 15,
"persons": 10,
"gram": 18,
"comment": "...",
"product": {
"id": 16,
"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": 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
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": 17
},
"product_price": {
"id": 16,
"name": "...",
"price": 18
},
"calculated_prices": {
"unit_price": 17,
"price": 18
},
"discount_prices": {
"unit_price": 19,
"price": 18
},
"options": [
{
"id": 12,
"name": "...",
"price_change": 19,
"optionset": {
"id": 11,
"name": "...",
"allow_attachment": false
}
},
{
"id": 10,
"name": "...",
"price_change": 14,
"optionset": {
"id": 16,
"name": "...",
"allow_attachment": true
}
},
{
"id": 18,
"name": "...",
"price_change": 13,
"optionset": {
"id": 19,
"name": "...",
"allow_attachment": true
}
}
],
"uploads": [
{
"upload": {
"id": 16,
"url": "https://example.com"
},
"optionset_id": 15
},
{
"upload": {
"id": 17,
"url": "https://example.com"
},
"optionset_id": 14
},
{
"upload": {
"id": 13,
"url": "https://example.com"
},
"optionset_id": 10
}
],
"code": "..."
},
{
"amount": 18,
"persons": 18,
"gram": 14,
"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": 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": 11
},
"product_price": {
"id": 12,
"name": "...",
"price": 16
},
"calculated_prices": {
"unit_price": 15,
"price": 14
},
"discount_prices": {
"unit_price": 12,
"price": 18
},
"options": [
{
"id": 13,
"name": "...",
"price_change": 15,
"optionset": {
"id": 11,
"name": "...",
"allow_attachment": false
}
},
{
"id": 18,
"name": "...",
"price_change": 17,
"optionset": {
"id": 16,
"name": "...",
"allow_attachment": true
}
},
{
"id": 14,
"name": "...",
"price_change": 14,
"optionset": {
"id": 19,
"name": "...",
"allow_attachment": true
}
}
],
"uploads": [
{
"upload": {
"id": 18,
"url": "https://example.com"
},
"optionset_id": 18
},
{
"upload": {
"id": 17,
"url": "https://example.com"
},
"optionset_id": 18
},
{
"upload": {
"id": 12,
"url": "https://example.com"
},
"optionset_id": 15
}
],
"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": 15
},
"consumer": {
"email": "example@domain.com",
"firstname": "...",
"lastname": "...",
"phone": "+32 475 00 00 00"
},
"created_at": "2019-01-31 12:00:00"
},
{
"id": 13,
"shop_id": 19,
"company_id": 11,
"status": "PENDING",
"order_nr": 10,
"prices": {
"price": 14,
"discount": 13,
"warranty": 19,
"delivery_cost": 17,
"invoice_cost": 15,
"sms_cost": 18,
"transaction_cost": 13,
"price_to_pay": 19
},
"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": "..."
},
"products": [
{
"amount": 14,
"persons": 10,
"gram": 18,
"comment": "...",
"product": {
"id": 14,
"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": true,
"price": 12
},
"product_price": {
"id": 19,
"name": "...",
"price": 14
},
"calculated_prices": {
"unit_price": 11,
"price": 19
},
"discount_prices": {
"unit_price": 18,
"price": 15
},
"options": [
{
"id": 14,
"name": "...",
"price_change": 14,
"optionset": {
"id": 16,
"name": "...",
"allow_attachment": true
}
},
{
"id": 15,
"name": "...",
"price_change": 15,
"optionset": {
"id": 17,
"name": "...",
"allow_attachment": false
}
},
{
"id": 15,
"name": "...",
"price_change": 16,
"optionset": {
"id": 17,
"name": "...",
"allow_attachment": true
}
}
],
"uploads": [
{
"upload": {
"id": 14,
"url": "https://example.com"
},
"optionset_id": 18
},
{
"upload": {
"id": 12,
"url": "https://example.com"
},
"optionset_id": 19
},
{
"upload": {
"id": 16,
"url": "https://example.com"
},
"optionset_id": 16
}
],
"code": "..."
},
{
"amount": 15,
"persons": 19,
"gram": 14,
"comment": "...",
"product": {
"id": 15,
"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": false,
"price": 19
},
"product_price": {
"id": 15,
"name": "...",
"price": 13
},
"calculated_prices": {
"unit_price": 19,
"price": 17
},
"discount_prices": {
"unit_price": 12,
"price": 11
},
"options": [
{
"id": 11,
"name": "...",
"price_change": 14,
"optionset": {
"id": 16,
"name": "...",
"allow_attachment": true
}
},
{
"id": 19,
"name": "...",
"price_change": 10,
"optionset": {
"id": 11,
"name": "...",
"allow_attachment": true
}
},
{
"id": 16,
"name": "...",
"price_change": 14,
"optionset": {
"id": 14,
"name": "...",
"allow_attachment": true
}
}
],
"uploads": [
{
"upload": {
"id": 17,
"url": "https://example.com"
},
"optionset_id": 13
},
{
"upload": {
"id": 13,
"url": "https://example.com"
},
"optionset_id": 10
},
{
"upload": {
"id": 17,
"url": "https://example.com"
},
"optionset_id": 15
}
],
"code": "..."
},
{
"amount": 11,
"persons": 15,
"gram": 10,
"comment": "...",
"product": {
"id": 14,
"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": true,
"price": 14
},
"product_price": {
"id": 16,
"name": "...",
"price": 13
},
"calculated_prices": {
"unit_price": 11,
"price": 16
},
"discount_prices": {
"unit_price": 13,
"price": 18
},
"options": [
{
"id": 13,
"name": "...",
"price_change": 17,
"optionset": {
"id": 10,
"name": "...",
"allow_attachment": true
}
},
{
"id": 16,
"name": "...",
"price_change": 11,
"optionset": {
"id": 17,
"name": "...",
"allow_attachment": true
}
},
{
"id": 11,
"name": "...",
"price_change": 15,
"optionset": {
"id": 10,
"name": "...",
"allow_attachment": true
}
}
],
"uploads": [
{
"upload": {
"id": 15,
"url": "https://example.com"
},
"optionset_id": 15
},
{
"upload": {
"id": 12,
"url": "https://example.com"
},
"optionset_id": 13
},
{
"upload": {
"id": 16,
"url": "https://example.com"
},
"optionset_id": 10
}
],
"code": "..."
}
],
"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": 12
},
"consumer": {
"email": "example@domain.com",
"firstname": "...",
"lastname": "...",
"phone": "+32 475 00 00 00"
},
"created_at": "2019-01-31 12:00:00"
}
],
"next": {
"status": "PENDING",
"created_after": "2019-01-31 12:00:00",
"created_before": "2019-01-31 12:00:00",
"before_id": 10,
"after_id": 11,
"sort": "ascending"
}
}