819df1427359
All Orders
<h3 style="background-color:#EC771A;color:#FFFFFF;margin:5px">This operation is deprecated. Use <a href="https://api.channable.com/v1/docs#tag/orders/operation/all_orders_v2_v2_companies__company_id__projects__project_id__orders_get">All orders v2</a> instead.</h3>This endpoint retrieves all orders for a given project of your company, sorted from most recent to oldest. Optionally, you can pass query parameters to customize the response content.
Note that the order data itself (like address information) can not be modified.
Timezones
When using the start_date, end_date, last_modified_after, last_modified_before, retrieved_at_start or retrieved_at_end parameters please keep in mind that the we will interpret the provided dates and times to be in UTC timezone.
The timestamps on the returned orders are ISO 8601 compliant and have a UTC offset of +00:00.
Example usage
Suppose the following scenario for a given project of yours: - The project contains the orders o1, o2, o3, and o4 (from oldest to most recent) - o3 contains some error - o1 and o4 are searchable by the term t - o3 is searchable by the term tE
| Request parameters | Response |
|---|---|
| none | {"orders": [o4, o3, o2, o1], "error_count": 1, "total": 4} |
| ?errors=true | {"orders": [o3], "error_count": 1, "total": 1} |
| ?limit=2 | {"orders": [o4, o3], "error_count": 1, "total": 2} |
| ?offset=1 | {"orders": [o3, o2, o1], "error_count": 1, "total": 3} |
| ?offset=4 | {"orders": [], "error_count": 1, "total": 0} |
| ?offset=1&limit=1 | {"orders": [o3], "error_count": 1, "total": 1} |
| ?offset=1&limit=2 | {"orders": [o3, o2], "error_count": 1, "total": 2} |
| ?offset=1&limit=2&errors=true | {"orders": [o3], "error_count": 1, "total": 1} |
| ?search=t | {"orders": [o4, o1], "error_count": 0, "total": 2} |
| ?search=t&errors=true | {"orders": [], "error_count": 1, "total": 0} |
| ?search=tE | {"orders": [o3], "error_count": 1, "total": 1} |
| ?search=tE&errors=true | {"orders": [o3], "error_count": 1, "total": 1} |
| ?offset=1&limit=2&search=t&errors=true | {"orders": [], "error_count": 1, "total": 0} |
| ?status=not_shipped | {"orders": [o4], "error_count": 1, "total": 1} |
| ?start_date=2018-01-01 | {"orders": [o4, o3, o2], "error_count": 1, "total": 3} |
| ?start_date=2018-01-01&end_date=2018-02-28 | {"orders": [o3, o2], "error_count": 1, "total": 2} |
| ?last_modified_after=2018-02-29 | {"orders": [o4], "error_count": 1, "total": 1} |
Path parameters
Query parameters
If true, a file download will be served
If true, a file download will be served
Any text based search query
Any text based search query
Max number of results in a single page.
Max number of results in a single page.
Filter results starting from this offset.
Filter results starting from this offset.
Response
Successful Response
Example response
{
"channels": [
{
"id": 1,
"name": "Example order connection"
}
],
"error_count": 0,
"orders": [
{
"attachments": [],
"channel_id": "123456789-6049197",
"channel_id_internal": "",
"channel_name": "ebay",
"created": "2022-04-19T06:38:23.044176+00:00",
"data": {
"billing": {
"address1": "Test street 1 bis",
"address2": "",
"address_supplement": "Extra address info",
"city": "Test",
"company": "Test company",
"country_code": "NL",
"email": "dontemail@me.net",
"first_name": "Test order",
"house_number": 1,
"house_number_ext": "bis",
"last_name": "from Channable",
"middle_name": "",
"region": "Limburg",
"region_code": "LI",
"street": "Test street",
"tax_id_number": "",
"vat_number": "NL123456790B01",
"zip_code": "1234 AB"
},
"customer": {
"business_order": false,
"company": "Test company",
"customer_channel_id": "",
"email": "dontemail@me.net",
"first_name": "Test",
"gender": "male",
"last_name": "from Channable",
"middle_name": "",
"mobile": "123456789",
"phone": "123456789"
},
"delivery_request": {
"carrier": "",
"method": "Standard",
"promise": "3 days",
"shipment_promise": "2019-11-08"
},
"extra": {
"comment": "Order id: 123",
"external_status": "",
"is_demo_order": false,
"is_test_order": false,
"label": "",
"memo": "Order from Channable"
},
"price": {
"commission": 0.32,
"currency": "EUR",
"discount": 0,
"payment_details_iban": "",
"payment_method": "channable",
"shipping": 1,
"subtotal": 8,
"total": 10,
"transaction_fee": 1,
"transaction_id": ""
},
"products": [
{
"article_number": "",
"commission": 0.32,
"delivery_period": "2016-06-28+02:00",
"ean": "",
"gift_message": "",
"id": "3124567",
"price": 8,
"quantity": 1,
"reference_code": "123",
"shipping": 1,
"title": "Test item"
}
],
"shipping": {
"address1": "Test street 1 bis",
"address2": "",
"address_supplement": "",
"city": "Test",
"company": "Test company",
"country_code": "NL",
"email": "dontemail@me.net",
"first_name": "Test order",
"house_number": 1,
"house_number_ext": "bis",
"last_name": "from Channable",
"middle_name": "",
"pickup_point_name": "",
"region": "Limburg",
"region_code": "LI",
"shipping_center_id": "",
"street": "Test street",
"zip_code": "1234 AB"
}
},
"error": false,
"id": 8355,
"modified": "2022-05-20T14:47:58.995190+00:00",
"obfuscated": false,
"order_config_id": 98734,
"platform_id": "8355",
"platform_name": "lightspeed",
"project_id": 53967,
"retrieved_at": "2022-04-19T06:38:23.044176+00:00",
"status_paid": "paid",
"status_shipped": "not_shipped",
"supports_alternate_id_mapping": false,
"supports_order_attachments": false,
"supports_partial_fulfillments": true,
"supports_tracking": true
}
],
"total": 1
}