Skip to content

Retrieve a list of orders

Request

Retrieves details for a bulk of orders that have been submitted within a given time range and optionally by order status or customer.

Path
partnerstringrequired

This is the partner code provided to you during onboarding. e.g. metamask.

Query
startstringrequired

The start date of the dataset in UTC. This is inclusive: orders created at this exact date will be included.

endstringrequired

The end date of the dataset in UTC. This is inclusive: orders created at this exact date will be included.

skipstring

The number of orders to skip in the dataset.

pagestring

The page of orders that are returned.

externalCustomerIdstring

Indicates the customer identifier that was used when creating the order. Orders will be filtered based on orders made by this customer.

statusstring

Indicates the current status of the order. One or many statuses can be passed.

limitstring

The limit of orders that are returned. If not provided, then default to 100 records.

Headers
Acceptstring
Default:"application/json"
x-api-keystring

This is the API Key that has been provided to you during onboarding.

curl -i -X GET \
  'https://docs.banxa.com/_mock/products/hosted-checkout/openapi/{partner}/v2/orders?start=string&end=string&skip=string&page=string&externalCustomerId=string&status=string&limit=string' \
  -H 'Accept: application/json' \
  -H 'x-api-key: string'

Responses

200

Bodyapplication/json
ordersArray of objects
pageTotalinteger
Default:0
Example:100
totalinteger
Default:0
Example:2654
Response
{
  "orders": [
    { … },
    { … }
  ],
  "pageTotal": 100,
  "total": 2654
}
© Banxa 2026