API Reference

List orders

get
https://api.ecommerceapi.uk/v1/orders

Retrieves a list of orders with optional filters and pagination.

Query Params
string

Comma-separated list of specific order IDs to return (maximum 50).

integer
enum

Specify 0 for non-archived orders, 1 for archived orders.

Allowed:
integer

The ID of the order status.

string

Return orders created after this UNIX timestamp.

string

Return orders created before this UNIX timestamp.

integer

Number of records to retrieve.

integer

Number of records to skip.

string
enum

Sort order.

Allowed:
string

Comma-separated list of fields to include in the response.

string

Comma-separated list of related resources to embed in the response. Possible values: admin_comments, file_archives, bundle_products, custom_fields, custom_product_fields, sales_tax, sales_tax_info, sales_tax_breakdown.

Responses

400

Invalid request parameters.

401

Unauthorized. Invalid or missing API key.

500

Server error.

Updated about 1 month ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago