List sales orders
List sales orders, 100 per page, with items, amounts, payment, shipping and addresses. Filter by update date, sales channel, fulfillment status or assigning status.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Only orders updated at or after this time (yyyy-mm-dd hh:mm:ss)
Sales channel code
Responses
Section titled “ Responses ”200 Success.
object
Order number (increment id).
Channel order number.
Order status.
Subtotal incl. tax.
Incl. tax.
Tax total.
object
object
object
object
object
object
Assigned to fulfillment orders.
Price incl. tax, after discount (fulfillment price semantics).
Price incl. tax, before discount.
Discount incl. tax.
Total incl. tax, after discount.
Tax amount.
Example generated
[ { "id": 1, "order_number": "example", "sales_order_number": "example", "channel_code": "example", "status": "example", "assigning_status": "example", "fulfillment_status": "example", "payment_status": "example", "currency_code": "example", "subtotal": 1, "subtotal_excl_tax": 1, "shipping_amount": 1, "shipping_amount_excl_tax": 1, "shipping_tax_amount": 1, "shipping_tax_percent": 1, "grand_total": 1, "grand_total_excl_tax": 1, "tax_amount": 1, "total_qty": 1, "customer_firstname": "example", "customer_lastname": "example", "customer_email": "example", "customer_is_guest": true, "created_at": "example", "updated_at": "example", "payment": { "method_code": "example", "method_name": "example" }, "shipping": { "method_code": "example", "method_name": "example", "internal_method_code": "example", "customer_note": "example", "pickup_point_delivery": { "location_id": "example", "location_name": "example" } }, "billing_address": { "firstname": "example", "lastname": "example", "email": "example", "street": "example", "city": "example", "postcode": "example", "region": "example", "country_id": "example", "telephone": "example", "company": "example", "vat_id": "example" }, "shipping_address": { "firstname": "example", "lastname": "example", "email": "example", "street": "example", "city": "example", "postcode": "example", "region": "example", "country_id": "example", "telephone": "example", "company": "example", "vat_id": "example" }, "items": [ { "id": 1, "sku": "example", "erp_sku": "example", "external_item_id": 1, "name": "example", "qty": 1, "qty_canceled": 1, "qty_invoiced": 1, "qty_shipped": 1, "qty_refunded": 1, "qty_ship_requested": 1, "price": 1, "price_excl_tax": 1, "price_excl_discount": 1, "discount_amount": 1, "row_total": 1, "row_total_excl_tax": 1, "row_discount_amount": 1, "tax_amount": 1, "tax_percent": 1 } ] }]object
Order number (increment id).
Channel order number.
Order status.
Subtotal incl. tax.
Incl. tax.
Tax total.
object
object
object
object
object
object
Assigned to fulfillment orders.
Price incl. tax, after discount (fulfillment price semantics).
Price incl. tax, before discount.
Discount incl. tax.
Total incl. tax, after discount.
Tax amount.
400 Bad Request
object
Error message
Errors list
Error details
object
Error message
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Error code
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Stack trace
Example generated
{ "message": "example", "errors": [ { "message": "example", "parameters": [ { "resources": "example", "fieldName": "example", "fieldValue": "example" } ] } ], "code": 1, "parameters": [ { "resources": "example", "fieldName": "example", "fieldValue": "example" } ], "trace": "example"}object
Error message
Errors list
Error details
object
Error message
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Error code
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Stack trace
401 Unauthorized
object
Error message
Errors list
Error details
object
Error message
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Error code
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Stack trace
Example generated
{ "message": "example", "errors": [ { "message": "example", "parameters": [ { "resources": "example", "fieldName": "example", "fieldValue": "example" } ] } ], "code": 1, "parameters": [ { "resources": "example", "fieldName": "example", "fieldValue": "example" } ], "trace": "example"}object
Error message
Errors list
Error details
object
Error message
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Error code
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Stack trace
default
Section titled “default ”Unexpected error
object
Error message
Errors list
Error details
object
Error message
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Error code
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Stack trace
Example generated
{ "message": "example", "errors": [ { "message": "example", "parameters": [ { "resources": "example", "fieldName": "example", "fieldValue": "example" } ] } ], "code": 1, "parameters": [ { "resources": "example", "fieldName": "example", "fieldValue": "example" } ], "trace": "example"}object
Error message
Errors list
Error details
object
Error message
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Error code
Error parameters list
Error parameters item
object
ACL resource
Missing or invalid field name
Incorrect field value
Stack trace