Retrieve a list of orders and their details

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Allows advanced filtering using the function-based DSL. For more information please visit https://developers.unify-retail.com/docs/filtering

Allowed field(s)/operator(s):

order_id : equals, not-equals, contains, any, none, is-null

order_uuid, status, type, device, source, carrier_uuid, location_store_app_uuid, country_code : equals, not-equals, any, none, is-null

amount : equals, not-equals, less-than, less-or-equal, greater-than, greater-or-equal, any, none, is-null

date : equals, less-than, less-or-equal, greater-than, greater-or-equal, is-null

first_name, last_name : equals, not-equals, contains, starts-with, ends-with, any, none, is-null

email : equals, not-equals, contains, any, none, is-null

item_id, item_type, preparation_request_id, preparation_type, transaction_id, return_id : equals, not-equals, any, none, is-null

reference : equals, not-equals, contains, any, none, is-null

location_uuid, location_id : equals, any, none, is-null

tags : contains, contains-any, contains-all, is-empty, is-not-empty

Amounts are expressed in the major currency unit (e.g. 19.99 for 19,99 €), like the classic price parameters.

string

Unique code for the shipping carrier (e.g., DHL, UPS, COL)

include
array of strings

Array of related resources to include in the response

include
Allowed:
integer
≥ 1
Defaults to 1

Page number to retrieve. Default: 1

integer
1 to 1000
Defaults to 50

Number of records to return per page. Default: 50. Maximum: 1000

string
deprecated

List of order IDs (separated by commas)

Deprecated - use filter=any(order_id,["C25010000001"]) instead.

string
enum
deprecated

Status of the order

Deprecated - use filter=any(status,["shipped","delivered"]) instead.

string
enum
Defaults to standard
deprecated

Order type

Deprecated - use filter=equals(type,"standard") instead.

Allowed:
string
enum
deprecated

Order device

Deprecated - use filter=equals(device,"web") instead.

Allowed:
string
enum
deprecated

Order source (if multiple, separate by commas)

Deprecated - use filter=equals(source,"web") instead.

Allowed:
string
deprecated

List of location IDs (separated by commas)

Deprecated - use filter=equals(location_id,"0002") instead.

string
deprecated

List of transaction IDs (separated by commas)

Deprecated - use filter=any(transaction_id,["TR123"]) instead.

string
deprecated

ISO 3166-1 alpha-2 country code

Deprecated - use filter=any(country_code,["FR"]) instead.

date-time
deprecated

Mandatory if date_end is provided

Deprecated - use filter=greater-or-equal(date,"2026-01-01 00:00:00") instead.

date-time
deprecated

Mandatory if date_start is provided

Deprecated - use filter=less-or-equal(date,"2026-01-31 23:59:59") instead.

number
deprecated

Minimum price of the item to retrieve. Mandatory if max_price is provided

Deprecated - use filter=greater-or-equal(amount,10) instead.

number
deprecated

Maximum price of the item to retrieve. Mandatory if min_price is provided

Deprecated - use filter=less-or-equal(amount,50) instead.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json