Skip to main content

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.

AttributeTypeOperatorExample
statusstringeqeq(status,complete)
paymentstringeqeq(payment,paid)
shippingstringeqeq(shipping,unfulfilled)
name (customer.name)stringeq / likelike(name,Brad*)
email (customer.email)stringeq / likelike(email,*@elasticpath.com)
customer_idstringeq / likeeq(customer_id, e5a0d684-a4af-4919-a348-f66b0b4955e0)
account_idstringeq / likeeq(account_id,3d7200c9-a9bc-4085-9822-63e80fd94a09)
account_member_idstringeq / likeeq(account_member_id,2a8a3a92-2ccd-4b2b-a7af-52d3896eaecb)
contact.namestringeq / likeeq(name,John Doe)
contact.emailstringeq / likeeq(email,John Doe)
shipping_postcodestringeq / likelike(shipping_postcode,117*)
billing_postcodestringeq / likelike(billing_postcode,117*)
with_taxintegergt/ge/lt/lege(with_tax,10000)
without_taxintegergt/ge/lt/lege(without_tax,10000)
currencystringeqeq(currency,USD)
product_idstringeqeq(product_id,6837058c-ae42-46db-b3c6-7f01e0c34b40)
product_skustringeqeq(product_sku,deck-shoe-001)
created_atdateeq / gt / ge/ le / ltgt(created_at,YYYY-MM-DD)
updated_atdateeq / gt / ge/ le/ ltlt(updated_at,YYYY-MM-DD)
external_refstringeq / likelike(external_ref, 16be*)
order_numberstringeq / likelike(order_number, 123*)

Request

Responses

Response Headers