Search Orders
Search for all Orders
placed through your application given certain filter critera.
This endpoint will only return completed orders by default (no carts). However it is possible to use this endpoint as a “Search Carts” endpoint by combining two parameters.
If you wish to include IN_PROGRESS
orders AKA carts you can set the exclude_in_progress
query param to false
.
If you want to use order search to only search for IN_PROGRESS
orders, that is to say, searching for carts, you can include the the following query in your search body: {"bag_status": "IN_PROGRESS"}
.
You must still set exclude_in_progress
to false in this case.
Headers
Query Parameters
Body
User ID
Order ID
Referral ID
Bag ID
Bag Status
IN_PROGRESS
, SUBMITTED
, ACCEPTED
, COMPLETED
, PARTIALLY_REFUNDED
, REFUNDED
, REJECTED
, CANCELED
, BACKORDERED
Merchant ID
Before date
After date
Order ID in the Channels System
Response
The actual content of the response; A list of the result objects
Boolean indicating if this is the last page
The total count of pages available
The total count of objects available
Boolean indicating if this is the first page of the response
The total number of objects in this specific response
The page size selected at request time
The page number selected at request time
Boolean indicating if the response content is empty
Contains the cursor for the next page. This property will only be used for situations where the API does not support the page number/page size paradigm and it will mutually exclusive with the size/number fields in the response. If this property is returned it must be passed when requesting the next page from the API. Does not apply to endpoints that do not have a next_page_cursor query param documented.
Violet wrapper for springframework pageable
Violet Wrapper for springframework sort
Was this page helpful?