Skip to main content
OrdersVersion: v3

List Orders

GET/payments/orders

The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact, funnel products or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve order information.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:payments/orders.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

locationIdstring

LocationId is the id of the sub-account.

Example:3SwdhCu3svxI8AKsPJt6
altIdstringrequired

AltId is the unique identifier e.g: location id.

Example:3SwdhCu3svxI8AKsPJt6
statusstring

Order status.

Example:completed
paymentStatusstring

Payment Status of the Order

Available optionspaidunpaidrefundedpartially_paid
Example:unpaid
paymentModestring

Mode of payment.

Example:live
startAtstring

Starting interval of orders.

Example:2024-02-01
endAtstring

Closing interval of orders.

Example:2024-02-13
searchstring

The name of the order for searching.

Example:Awesome order
contactIdstring

Contact id for filtering of orders.

Example:XPLSw2SVagl12LMDeTmQ
funnelProductIdsstring

Funnel product ids separated by comma.

Example:61dd0c7dc077f712a5f787ff,61d6afc9d39ac5e35965c017
sourceIdstring

Source id

Example:61dd0c7dc077f712a5f787ff
limitnumber

The maximum number of items to be included in a single page of results

Default:10
Example:20
offsetnumber

The starting index of the page, indicating the position from which the results should be retrieved.

Default:0
Example:0

Response

Successful response

dataobject[]required

An array of orders

totalCountnumberrequired

total orders count