v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
eCommerce
Orders

Get all orders

Returns a list of all the orders

get/consumers/{consumer_id}/commerce/orders

Path parameters

consumer_idstring uuid required

Query parameters

pageinteger

Page number

sizeinteger

Page size

date_fromstring date nullable

Filter orders created at or after this date (e.g. 2023-01-31)

date_tostring date nullable

Filter orders created at or before this date (e.g. 2023-01-31)

updated_afterstring date-time nullable

Filter orders last updated at or after this date (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.

include_detailed_refunds'true' | 'false'

Include detailed information concerning refunds

include_product_categories'true' | 'false'

Include detailed information about categories

include_customer_details'true' | 'false'

Include detailed information about customer

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required