Sign in
Orders

Retrieve an Orders List from a query.

Endpoint example:

 https://api.jumpseller.com/v1/orders/search.json?fulfillment_filters=unfulfilled,fulfilled&status_filters[]=paid&status_filters[]=abandoned&dateFilter=last7days
get/orders/search.json

Query parameters

localestring string

Locale code of the translation

querystring string

Text to query for the Order

status_filters[]'paid' | 'created' | 'pending_payment' | 'canceled' | 'abandoned' string

Order Status to query for the Order

fulfillment_filters'unfulfilled' | 'fulfilled' string

Comma separated values of the fulfillment filters to query for the Order

dateFilter'today' | 'yesterday' | 'last30days' | 'last7days' | 'last90days' | 'customDate' string

Date to query for the Order.

initialDatestring string

Starting date to query for the Order in the format YYYY-MM-DD. CustomDate and finalDate need to be used

finalDatestring string

Starting date to query for the Order in the format YYYY-MM-DD. CustomDate and initialDate need to be used

fields'id' | 'tax' | '...' string

Comma separated values of the fields to query for the Order

limitinteger

List restriction

pageinteger

List page

Response

OK

countinteger

Total number of orders matching the query

Changes

No recorded changes to this endpoint across all 3 revisions of this API.