List Orders

GET

vendor

orders

curl 'http://localhost:9000/vendor/orders?limit=20&order=-created_at' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { orders, count } = await client.vendor.orders.query({
  limit: 20,
  order: "-created_at",
})

{
  "orders": [
    {
      "id": "order_01HXYZABCDEF",
      "display_id": 42,
      "status": "pending",
      "email": "jane@example.com",
      "currency_code": "usd",
      "region_id": "reg_01HXYZABCDEF",
      "customer_id": "cus_01HXYZABCDEF",
      "sales_channel_id": "sc_01HXYZABCDEF",
      "items": [
        {
          "id": "ordli_01HXYZABCDEF",
          "title": "T-Shirt / M",
          "quantity": 1,
          "unit_price": 2500
        }
      ],
      "created_at": "2026-06-01T10:00:00.000Z",
      "updated_at": "2026-06-01T10:00:00.000Z",
      "canceled_at": null
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns all non-draft orders belonging to the authenticated seller, with optional filtering by status, customer, region, and more.

Query parameters

number

default:"50"

Maximum number of records to return.

number

default:"0"

Number of records to skip.

string

Field to sort by, prefix with - for descending order.

string

Comma-separated list of fields to include, prefix with +/- to add or remove from defaults.

string

Search term matched against order fields.

string | string[]

Filter by order ID(s).

string | string[]

Filter by order status.

string | string[]

Filter by customer ID(s).

string | string[]

Filter by sales channel ID(s).

string | string[]

Filter by region ID(s).

string | string[]

Filter by currency code(s).

string

Filter by fulfillment status.

string

Filter by payment status.

object

Filter by creation date with operators like $gte, $lte.

object

Filter by update date with operators like $gte, $lte.

Response

object[]

Show properties

string

The order’s ID.

number

Human-readable order number.

string

The order’s status.

string

The customer’s email.

string

The order’s currency code.

string

ID of the order’s region.

string

ID of the customer.

string

ID of the sales channel.

object[]

The order’s line items, including variant, product, and offer data.

object

The order’s shipping address.

object

The order’s billing address.

object[]

The order’s shipping methods.

object[]

Payment collections with payments and refunds.

object[]

The order’s fulfillments.

object[]

The order’s returns with items and reasons.

object

Order totals summary.

object

Custom key-value data.

string

Creation timestamp.

string

Last update timestamp.

string

Cancellation timestamp, if canceled.

number

Total number of matching orders.

number

Number of records skipped.

number

Number of records returned.

curl 'http://localhost:9000/vendor/orders?limit=20&order=-created_at' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { orders, count } = await client.vendor.orders.query({
  limit: 20,
  order: "-created_at",
})

{
  "orders": [
    {
      "id": "order_01HXYZABCDEF",
      "display_id": 42,
      "status": "pending",
      "email": "jane@example.com",
      "currency_code": "usd",
      "region_id": "reg_01HXYZABCDEF",
      "customer_id": "cus_01HXYZABCDEF",
      "sales_channel_id": "sc_01HXYZABCDEF",
      "items": [
        {
          "id": "ordli_01HXYZABCDEF",
          "title": "T-Shirt / M",
          "quantity": 1,
          "unit_price": 2500
        }
      ],
      "created_at": "2026-06-01T10:00:00.000Z",
      "updated_at": "2026-06-01T10:00:00.000Z",
      "canceled_at": null
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/vendor/orders?limit=20&order=-created_at' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { orders, count } = await client.vendor.orders.query({
  limit: 20,
  order: "-created_at",
})

{
  "orders": [
    {
      "id": "order_01HXYZABCDEF",
      "display_id": 42,
      "status": "pending",
      "email": "jane@example.com",
      "currency_code": "usd",
      "region_id": "reg_01HXYZABCDEF",
      "customer_id": "cus_01HXYZABCDEF",
      "sales_channel_id": "sc_01HXYZABCDEF",
      "items": [
        {
          "id": "ordli_01HXYZABCDEF",
          "title": "T-Shirt / M",
          "quantity": 1,
          "unit_price": 2500
        }
      ],
      "created_at": "2026-06-01T10:00:00.000Z",
      "updated_at": "2026-06-01T10:00:00.000Z",
      "canceled_at": null
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response