GET
/
v1
/
collections
/
{id}
/
sales

Authorizations

x-api-key
string
headerrequired

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Path Parameters

id
string
required

The unique identifier of the collection.

Query Parameters

min_order_date
string

The earliest order date to filter sales.

max_order_date
string

The latest order date to filter sales.

min_total
number

The minimum total sale amount to filter by.

max_total
number

The maximum total sale amount to filter by.

email
string

The email address associated with the sale to filter by.

order_number
string

The order number to filter sales.

limit
integer

The maximum number of items to return (1-1000).

Required range: 1 < x < 1000
offset
integer

The number of items to skip before starting to collect the result set.

order
enum<string>

The sort order of the results.

Available options:
asc,
desc
order_by
string

The field by which to order the results.

Response

200 - application/json
data
object[]

List of sales records for the collection.

pagination
object