v1
latestOpenAPI 3.0.02026-07-2475182625.5 KBList all orders
Returns a list of your orders by order ID.
Query parameters
Filters results to include transactions after the specified begin date (in YYYY-MM-DD format). Must be at least one day before the specified end date.
Filters results to include transactions within a certain time frame.
Filters results to include transactions before the specified end date (in YYYY-MM-DD format).
Limits the number of order records returned per page (default is 50 records).
Specifies the page number of results to be returned; used together with limit to control pagination.
Filters results to include only transactions involving the specified product path(s).
Filters results to include or exclude subscription rebill transactions.
If true, the results will include subscription rebill transactions.
If false, the results will exclude subscription rebill transactions.
Filters results to include orders with or without returns; response includes returns array with return IDs where applicable.
Filters results to include live transactions, test transactions, or both.
Filters results by transaction status.
completed = successful orders
canceled = declined orders
failed = transaction failed to complete
Response
OK
Example response
{
"action": "order.getall",
"result": "success",
"page": 1,
"limit": 50,
"nextPage": 2,
"total": 2,
"orders": [
"abcDEFgHiJklM1N-3OP9q",
"rST2uv1wXy279zABCd_E2f"
]
}