Get all Orders
GET/v2/orders
This endpoint returns all orders with custom flow fields. The pagination offset is set to fetch a maximum of 10,000 orders. If the store has 10,000 orders and you fetch the orders without using filters, an error is returned. Use a filter to view orders when the order is beyond the 10,000 mark.
note
- Pass the
X-Moltin-Customer-Token
header to limit orders to a specific customer. See Customer Tokens. - Pass the
EP-Account-Management-Authentication-Token
header to limit orders to a specific account. See Account Management Token. - You can use pagination with this resource. For more information, see pagination.
Filtering
The following operators and attributes are available for filtering orders.
Attribute | Type | Operator | Example |
---|---|---|---|
status | string | eq | eq(status,complete) |
payment | string | eq | eq(payment,paid) |
shipping | string | eq | eq(shipping,unfulfilled) |
name (customer.name ) | string | eq / like | like(name,Brad*) |
email (customer.email ) | string | eq / like | like(email,*@elasticpath.com) |
customer_id | string | eq / like | eq(customer_id, e5a0d684-a4af-4919-a348-f66b0b4955e0) |
account_id | string | eq / like | eq(account_id,3d7200c9-a9bc-4085-9822-63e80fd94a09) |
account_member_id | string | eq / like | eq(account_member_id,2a8a3a92-2ccd-4b2b-a7af-52d3896eaecb) |
contact.name | string | eq / like | eq(name,John Doe) |
contact.email | string | eq / like | eq(email,John Doe) |
shipping_postcode | string | eq / like | like(shipping_postcode,117*) |
billing_postcode | string | eq / like | like(billing_postcode,117*) |
with_tax | integer | gt /ge /lt /le | ge(with_tax,10000) |
without_tax | integer | gt /ge /lt /le | ge(without_tax,10000) |
currency | string | eq | eq(currency,USD) |
product_id | string | eq | eq(product_id,6837058c-ae42-46db-b3c6-7f01e0c34b40) |
product_sku | string | eq | eq(product_sku,deck-shoe-001) |
created_at | date | eq / gt / ge / le / lt | gt(created_at,YYYY-MM-DD) |
updated_at | date | eq / gt / ge / le / lt | lt(updated_at,YYYY-MM-DD) |
external_ref | string | eq / like | like(external_ref, 16be*) |
order_number | string | eq / like | like(order_number, 123*) |
Request
Responses
- 200
- 401
Response Headers
Unauthorized