API Reference
HomeWebsite

Retrieve a list of orders and their details

get
https://sandbox-api.unify-retail.com/v1/orders
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

List of order IDs (separated by commas)

string
enum

Status of the order

string
enum
Defaults to standard

Order type

Allowed:
string
enum

Order device

Allowed:
string
enum

Order source (if multiple, separate by commas)

Allowed:
string

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

string

List of location IDs (separated by commas)

string

List of transaction IDs (separated by commas)

string

ISO 3166-1 alpha-2 country code

date-time

Mandatory if date_end is provided

date-time

Mandatory if date_start is provided

include
array of strings

Array of related resources to include in the response

include
Allowed:
number

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

number

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

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

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?