List orders

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: orders, meta } = await client.orders.list({
  status_eq: 'complete',
  completed_at_gt: '2026-01-01',
  sort: '-completed_at',
  limit: 25,
})

{
  "data": [
    {
      "id": "or_UkLWZg9DAJ",
      "market_id": "mkt_UkLWZg9DAJ",
      "withdrawal_period_ends_at": null,
      "within_withdrawal_period": false,
      "shipping_eq_billing_address": false,
      "cart_id": null,
      "channel_id": "ch_UkLWZg9DAJ",
      "company_id": null,
      "company_name": null,
      "po_document_filename": null,
      "po_document_byte_size": null,
      "number": "R1001",
      "email": "viki_reichel@moorecummerata.us",
      "customer_note": null,
      "po_number": null,
      "currency": "USD",
      "locale": "en",
      "total_quantity": 0,
      "coupon_code": null,
      "fulfillment_status": null,
      "payment_status": null,
      "completed_at": null,
      "item_total": "0.00",
      "discount_total": "0.00",
      "tax_total": "0.00",
      "included_tax_total": "0.00",
      "additional_tax_total": "0.00",
      "delivery_total": "0.00",
      "fee_total": null,
      "gift_card_total": "0.00",
      "store_credit_total": "0.00",
      "total": "0.00",
      "amount_due": "0.00",
      "covered_by_store_credit": false,
      "adjustment_total": "0.00",
      "gift_card": null,
      "market": {
        "id": "mkt_UkLWZg9DAJ",
        "name": "United States",
        "currency": "USD",
        "default_locale": "en",
        "tax_inclusive": false,
        "default": true,
        "country_codes": [
          "US"
        ],
        "supported_locales": [
          "en"
        ],
        "created_at": "2026-01-15T12:00:00.000Z",
        "updated_at": "2026-01-15T12:00:00.000Z",
        "tax_provider": null
      },
      "external_references": {},
      "status": "draft",
      "last_ip_address": null,
      "considered_risky": false,
      "confirmation_delivered": false,
      "store_owner_notification_delivered": null,
      "metadata": {},
      "cancel_note": null,
      "canceled_at": null,
      "approved_at": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "payment_total": "0.00",
      "commission_amount_total": "0.00",
      "commission_tax_total": "0.00",
      "commission_total": "0.00",
      "preferred_stock_location_id": null,
      "po_document_url": null,
      "seller_id": null,
      "order_group_id": null,
      "tags": [],
      "internal_note": null,
      "internal_note_html": null,
      "approver_id": null,
      "approver_type": null,
      "canceler_id": null,
      "canceler_type": null,
      "created_by_id": null,
      "created_by_type": null,
      "cancel_reason_id": null,
      "cancel_reason_name": null,
      "customer_id": "cust_UkLWZg9DAJ",
      "freight_summary": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

GET

api

admin

orders

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: orders, meta } = await client.orders.list({
  status_eq: 'complete',
  completed_at_gt: '2026-01-01',
  sort: '-completed_at',
  limit: 25,
})

{
  "data": [
    {
      "id": "or_UkLWZg9DAJ",
      "market_id": "mkt_UkLWZg9DAJ",
      "withdrawal_period_ends_at": null,
      "within_withdrawal_period": false,
      "shipping_eq_billing_address": false,
      "cart_id": null,
      "channel_id": "ch_UkLWZg9DAJ",
      "company_id": null,
      "company_name": null,
      "po_document_filename": null,
      "po_document_byte_size": null,
      "number": "R1001",
      "email": "viki_reichel@moorecummerata.us",
      "customer_note": null,
      "po_number": null,
      "currency": "USD",
      "locale": "en",
      "total_quantity": 0,
      "coupon_code": null,
      "fulfillment_status": null,
      "payment_status": null,
      "completed_at": null,
      "item_total": "0.00",
      "discount_total": "0.00",
      "tax_total": "0.00",
      "included_tax_total": "0.00",
      "additional_tax_total": "0.00",
      "delivery_total": "0.00",
      "fee_total": null,
      "gift_card_total": "0.00",
      "store_credit_total": "0.00",
      "total": "0.00",
      "amount_due": "0.00",
      "covered_by_store_credit": false,
      "adjustment_total": "0.00",
      "gift_card": null,
      "market": {
        "id": "mkt_UkLWZg9DAJ",
        "name": "United States",
        "currency": "USD",
        "default_locale": "en",
        "tax_inclusive": false,
        "default": true,
        "country_codes": [
          "US"
        ],
        "supported_locales": [
          "en"
        ],
        "created_at": "2026-01-15T12:00:00.000Z",
        "updated_at": "2026-01-15T12:00:00.000Z",
        "tax_provider": null
      },
      "external_references": {},
      "status": "draft",
      "last_ip_address": null,
      "considered_risky": false,
      "confirmation_delivered": false,
      "store_owner_notification_delivered": null,
      "metadata": {},
      "cancel_note": null,
      "canceled_at": null,
      "approved_at": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "payment_total": "0.00",
      "commission_amount_total": "0.00",
      "commission_tax_total": "0.00",
      "commission_total": "0.00",
      "preferred_stock_location_id": null,
      "po_document_url": null,
      "seller_id": null,
      "order_group_id": null,
      "tags": [],
      "internal_note": null,
      "internal_note_html": null,
      "approver_id": null,
      "approver_type": null,
      "canceler_id": null,
      "canceler_type": null,
      "created_by_id": null,
      "created_by_type": null,
      "cancel_reason_id": null,
      "cancel_reason_name": null,
      "customer_id": "cust_UkLWZg9DAJ",
      "freight_summary": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[number_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`channel_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`completed_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`considered_risky`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`coupon_code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`currency`	One of the `CurrencyCode` codes	`eq` `not_eq` `in` `not_in` `null` `not_null`
`customer_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`delivery_total`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`email`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`fulfillment_status`	One of `backorder`, `canceled`, `partial`, `unfulfilled`, `fulfilled`, `delivered`, `pending`, `ready`, `shipped`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`item_total`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`locale`	One of the `LocaleCode` codes	`eq` `not_eq` `in` `not_in` `null` `not_null`
`market_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`number`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`order_group_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`payment_status`	One of `none`, `authorized`, `partially_paid`, `paid`, `partially_refunded`, `refunded`, `overcharged`, `voided`, `balance_due`, `credit_owed`, `failed`, `void`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`po_number`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`seller_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`status`	One of `draft`, `placed`, `canceled`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`total`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`total_quantity`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Filters through associations

Prefix an associated record’s attribute with the association, as in q[bill_address_id_eq]. The same predicates apply.

Prefix	Attributes
`bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`channel_`	`active`, `code`, `created_at`, `default`, `id`, `name`, `store_id`, `updated_at`
`customer_`	`accepts_email_marketing`, `created_at`, `email`, `first_name`, `id`, `last_name`, `phone`, `updated_at`
`customer_addresses_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customer_bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customer_customer_groups_`	`created_at`, `id`, `name`, `updated_at`
`customer_ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customer_spree_roles_`	`created_at`, `id`, `name`, `updated_at`
`customer_tags_`	`created_at`, `id`, `name`, `updated_at`
`fulfillments_`	`created_at`, `id`, `number`, `updated_at`
`line_items_`	`additional_tax_total`, `adjustment_total`, `cost_price`, `created_at`, `discount_total`, `id`, `included_tax_total`, `non_taxable_adjustment_total`, `order_id`, `pre_tax_amount`, `price`, `quantity`, `tax_category_id`, `taxable_adjustment_total`, `updated_at`, `variant_id`
`line_items_tax_category_`	`created_at`, `id`, `is_default`, `name`, `tax_code`, `updated_at`
`line_items_variant_`	`carton_package_type_id`, `carton_weight`, `cartons_per_pallet`, `cost_currency`, `cost_price`, `country_of_origin`, `created_at`, `deleted_at`, `depth`, `discontinue_on`, `height`, `hs_code`, `id`, `minimum_order_quantity`, `order_multiple`, `position`, `product_id`, `purchase_unit`, `sku`, `track_inventory`, `units_per_carton`, `updated_at`, `weight`, `width`
`order_group_`	`created_at`, `currency`, `email`, `id`, `number`, `updated_at`
`order_group_customer_`	`accepts_email_marketing`, `created_at`, `email`, `first_name`, `id`, `last_name`, `phone`, `updated_at`
`promotions_`	`code`, `created_at`, `expires_at`, `id`, `kind`, `name`, `path`, `promotion_category_id`, `starts_at`, `updated_at`
`promotions_coupon_codes_`	`code`, `created_at`, `id`, `promotion_id`, `state`, `updated_at`
`seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`shipments_`	`created_at`, `id`, `number`, `updated_at`
`store_`	`created_at`, `id`, `name`, `updated_at`
`tags_`	`created_at`, `id`, `name`, `updated_at`

Sort by: channel_id, completed_at, considered_risky, coupon_code, created_at, currency, customer_id, delivery_total, email, fulfillment_status, id, item_total, locale, market_id, number, order_group_id, payment_status, po_number, seller_id, status, total, total_quantity, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Bearer token for admin authentication

Query Parameters

q[search]

string

Matches order number or purchase order number (partial), the billing first or last name, or the exact email.

q[complete]

boolean

Set to true to apply complete.

q[incomplete]

boolean

Set to true to apply incomplete.

q[partially_refunded]

boolean

Set to true to apply partially_refunded.

q[refunded]

boolean

Set to true to apply refunded.

page

integer

Page number

limit

integer

Number of records per page

sort

string

Sort field (e.g., created_at, -created_at, completed_at)

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

expand

string

Comma-separated associations to expand (e.g., items, fulfillments, payments, customer, discounts, billing_address, shipping_address). Use dot notation for nested expand (max 4 levels).

fields

string

Comma-separated list of fields to include (e.g., number,total,status,completed_at). id is always included.

Response

orders found

⌘I

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters