GET
/
v1
/
collections
/
{id}
/
sales
curl --request GET \
  --url https://api.oneofnone.io/v1/collections/{id}/sales \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "collection_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "email": "jsmith@example.com",
      "id": 123,
      "order_date": "2023-11-07T05:31:56Z",
      "order_details": {},
      "order_number": "<string>",
      "quantity": 123,
      "retail_source": "<string>",
      "shipping_address": {},
      "shop_url": "<string>",
      "team_id": 123,
      "total": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "<string>",
    "prev": "<string>",
    "limit": 123,
    "offset": 123
  }
}

Authorizations

​
x-api-key
string
header
required

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
Successfully retrieved sales records for the collection.
​
data
object[]

List of sales records for the collection.

​
pagination
object