Get order list

GET /company/companies/@id/lists/orders

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int Company ID

Body

Pass the following properties via application/json or form encoding in the body of the request.

A dictionary with fields

Field Type Description
shop_ids [Int] Array of Int
start_date Date Date in YYYY-MM-DD
end_date Date Date in YYYY-MM-DD
acquire_methods [String] Array of String
sort_by String String enumarion of 'acquire_time', 'customer_name', 'order_number'
output_format String String enumarion of 'html', 'excel'
order_number_start Int Optional. An integer value
order_number_end Int Optional. An integer value
only_orders_with_warranty Bool Optional. A boolean value
page_mode String Optional. String enumarion of 'list', 'split_per_day', 'one_order_per_page'

Example request 1 

GET /company/companies/14/lists/orders HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 393

{
    "shop_ids": [
        13,
        10,
        14
    ],
    "start_date": "2019-01-31",
    "end_date": "2019-01-31",
    "acquire_methods": [
        "takeout",
        "delivery",
        "latch"
    ],
    "sort_by": "acquire_time",
    "output_format": "html",
    "order_number_start": 15,
    "order_number_end": 10,
    "only_orders_with_warranty": true,
    "page_mode": "list"
}

Response

Example response 1 

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 5


"..."
1.9.0 stable