Skip to main content
GET
/
v1
/
team
/
orders
List orders
curl --request GET \
  --url https://api.oneofnone.io/v1/team/orders \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_number": "<string>",
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "shipping_address": {
        "first_name": "<string>",
        "last_name": "<string>",
        "name": "<string>",
        "phone": "<string>",
        "company": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "zip": "<string>",
        "province": "<string>",
        "country": "<string>",
        "province_code": "<string>",
        "country_code": "<string>"
      },
      "line_items": [
        {
          "sku": "<string>",
          "name": "<string>",
          "quantity": 123,
          "price": 123,
          "total": 123,
          "properties": {}
        }
      ],
      "status": "PENDING",
      "total_amount": 123,
      "subtotal_amount": 123,
      "total_shipping": 123,
      "total_tax": 123,
      "total_discounts": 123,
      "customizations": {},
      "customer_id": "<string>",
      "order_status_url": "<string>",
      "source": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "https://api.example.com/users?limit=20&offset=20",
    "prev": "https://api.example.com/users?limit=20&offset=0",
    "limit": 20,
    "offset": 0,
    "total_count": 150,
    "total_pages": 8,
    "current_page": 1
  }
}

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.

Query Parameters

​
order_number
integer

Filter orders by order number.

Required range: x >= 1
​
email
string<email>

Filter orders by customer email.

​
min_date
string<date-time>

Filter orders created after this date.

​
max_date
string<date-time>

Filter orders created before this date.

​
limit
integer
default:1000

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

Required range: 1 <= x <= 1000
​
offset
integer
default:0

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

Required range: x >= 0
​
order
enum<string>
default:asc

The sort order of the results.

Available options:
asc,
desc
​
order_by
string

The field by which to order the results.

​
include_count
boolean
default:false

If true, returns additional pagination metadata including total count and total pages.

Response

Successfully retrieved team orders.

​
data
object[]
required
​
pagination
object
required