Orders

The /orders endpoint retrieves information about specific order events, or all orders within specified criteria.
You can apply the following parameters to return associated orders:

  • Order ID
  • Date range
  • Product path

You can apply multiple parameters to a single request. The API will return paginated results with up to 50 records per page.

πŸ‘

To limit page results, specify a custom limit to the number of records per page. Include the desired number per page in your request.

The following request parameters are available when calling the /orders endpoint

ParameterValuesDescription
beginyyyy-mm-ddfilters results to include transactions after the specified begin date (must be at least one day before the specified end date)
daysintegerfilters results to include transactions within a certain time frame
endyyyy-mm-ddfilters results to include transactions before the specified end date
limitintegerinteger limits the number of order records returned per page (default is 50 records)
pageintegerspecifies page number of results to be returned; used together with limit to control pagination
productsstringfilters results to include only transactions involving the specified product ID(s) / product path(s)
rebilltrue/falsefilters results to include only subscription rebill transactions or exclude all subscription rebill transactions
returnstrue/falsefilters results to include orders with or without returns; response includes returns array with return IDs where applicable
scopeall,live,testfilters results to include live transactions, test transactions, or both
statuscompleted, cancelled, failedfilters results by transaction status; "completed" = successful orders, "canceled" = declined orders, "failed" = transaction failed to complete (very uncommon)