List 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
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
payments/ orders. readonlyOAuthPrivate IntegrationSub-Account TokenRequest
Headers
API Version
v3Query Parameters
LocationId is the id of the sub-account.
3SwdhCu3svxI8AKsPJt6AltId is the unique identifier e.g: location id.
3SwdhCu3svxI8AKsPJt6Order status.
completedPayment Status of the Order
paidunpaidrefundedpartially_paidunpaidMode of payment.
liveStarting interval of orders.
2024-02-01Closing interval of orders.
2024-02-13The name of the order for searching.
Awesome orderContact id for filtering of orders.
XPLSw2SVagl12LMDeTmQFunnel product ids separated by comma.
61dd0c7dc077f712a5f787ff,61d6afc9d39ac5e35965c017Source id
61dd0c7dc077f712a5f787ffThe maximum number of items to be included in a single page of results
1020The starting index of the page, indicating the position from which the results should be retrieved.
00Response
Successful response
An array of orders
total orders count