List orders

GET

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": "[email protected]",
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "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

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

Show child attributes

data.order_id

string<uuid>

The unique identifier for the order.

data.order_number

string | null

The human-readable order number for customer reference.

data.team_id

string<uuid> | null

The unique identifier of the team that placed the order.

data.user_id

string<uuid> | null

The unique identifier of the user who placed the order.

data.email

string<email> | null

The email address associated with the order.

data.user

object

User information for the order placer.

Show child attributes

data.user.id

string<uuid>

The unique identifier of the user.

data.user.email

string<email> | null

The user's email address.

data.user.first_name

string | null

The user's first name.

data.user.last_name

string | null

The user's last name.

data.shipping_address

object

Shipping address information for the order.

Show child attributes

data.shipping_address.first_name

string | null

First name for shipping.

data.shipping_address.last_name

string | null

Last name for shipping.

data.shipping_address.name

string | null

Full name for shipping.

data.shipping_address.phone

string | null

Phone number for shipping contact.

data.shipping_address.company

string | null

Company name for shipping.

data.shipping_address.address1

string | null

Primary address line.

data.shipping_address.address2

string | null

Secondary address line (apartment, suite, etc.).

data.shipping_address.city

string | null

City for shipping.

data.shipping_address.zip

string | null

ZIP or postal code for shipping.

data.shipping_address.province

string | null

Province or state for shipping.

data.shipping_address.country

string | null

Country for shipping.

data.shipping_address.province_code

string | null

Province or state code for shipping.

data.shipping_address.country_code

string | null

Country code for shipping.

data.line_items

object[] | null

Array of items included in the order.

Show child attributes

data.line_items.sku

string

required

Stock Keeping Unit identifier for the item.

data.line_items.name

string

required

Display name of the item.

data.line_items.quantity

integer

required

Quantity of this item in the order.

data.line_items.price

number | null

Unit price of the item.

data.line_items.total

number | null

Total price for this line item (quantity × price).

data.line_items.properties

object

Custom properties or configurations for this item.

data.status

enum<string>

Current status of the order.

Available options:

PENDING,

CONFIRMED,

PROCESSING,

SHIPPED,

DELIVERED,

CANCELED

data.total_amount

number | null

Total amount for the entire order including all fees and taxes.

data.subtotal_amount

number | null

Subtotal amount before shipping, taxes, and discounts.

data.total_shipping

number | null

Total shipping costs for the order.

data.total_tax

number | null

Total tax amount for the order.

data.total_discounts

number | null

Total discount amount applied to the order.

data.customizations

object

Custom configurations or personalizations applied to the order.

data.customer_id

string | null

Shopify customer identifier who made the purchase.

data.order_status_url

string<uri> | null

Shopify order status URL where the customer can check order updates.

data.source

string | null

The system or platform where the order originated.

data.created_at

string<date-time>

The timestamp when the order was created.

data.updated_at

string<date-time> | null

The timestamp when the order was last updated.

pagination

object

required

Show child attributes

pagination.next

string | null

required

URL for the next page of results, null if this is the last page

Example:

"https://api.example.com/users?limit=20&offset=20"

pagination.prev

string | null

required

URL for the previous page of results, null if this is the first page

Example:

"https://api.example.com/users?limit=20&offset=0"

pagination.limit

integer

required

The maximum number of items returned per page

Required range: 1 <= x <= 1000

Example:

20

pagination.offset

integer

required

The number of items skipped before the current page

Required range: x >= 0

Example:

0

pagination.total_count

integer

Total number of items available (only included when count is requested)

Required range: x >= 0

Example:

150

pagination.total_pages

integer

Total number of pages available (only included when count is requested)

Required range: x >= 0

Example:

8

pagination.current_page

integer

Current page number (only included when count is requested)

Required range: x >= 1

Example:

1

Get orderFetches a single order by its order number for the team associated with the API key.

⌘I

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": "[email protected]",
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "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
  }
}

Getting Started

Access API

Activities API

Analytics API

Collections API

Registrations API

Short URLs API

Teams API

Users API

Authorizations

Query Parameters

Response