List order items

Spree Admin SDK

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

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

const { data: items } = await client.orders.items.list('or_UkLWZg9DAJ')

{
  "data": [
    {
      "id": "li_UkLWZg9DAJ",
      "variant_id": "variant_gbHJdmfrXB",
      "seller_id": null,
      "preorder": false,
      "preorder_ships_at": null,
      "quantity": 2,
      "currency": "USD",
      "name": "Product 779180",
      "slug": "product-779180",
      "options_text": "Size: S",
      "price": "10.00",
      "total": "20.00",
      "adjustment_total": "0.00",
      "additional_tax_total": "0.00",
      "included_tax_total": "0.00",
      "discount_total": "0.00",
      "pre_tax_amount": "20.00",
      "discounted_amount": "20.00",
      "compare_at_amount": null,
      "thumbnail_url": null,
      "option_values": [
        {
          "id": "optval_UkLWZg9DAJ",
          "option_type_id": "opt_UkLWZg9DAJ",
          "name": "size-13",
          "label": "S",
          "position": 1,
          "color_code": null,
          "option_type_name": "foo-size-23",
          "option_type_label": "Size",
          "image_url": null,
          "metadata": {},
          "created_at": "2026-01-15T12:00:00.000Z",
          "updated_at": "2026-01-15T12:00:00.000Z"
        }
      ],
      "digital_links": [],
      "external_references": {},
      "metadata": {},
      "price_source": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "catalog_price": "19.99",
      "price_list_id": null,
      "price_list_name": null,
      "catalog_id": null,
      "catalog_name": null,
      "cost_price": "17.00",
      "tax_category_id": "taxcat_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

admin

orders

{order_id}

items

Spree Admin SDK

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

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

const { data: items } = await client.orders.items.list('or_UkLWZg9DAJ')

{
  "data": [
    {
      "id": "li_UkLWZg9DAJ",
      "variant_id": "variant_gbHJdmfrXB",
      "seller_id": null,
      "preorder": false,
      "preorder_ships_at": null,
      "quantity": 2,
      "currency": "USD",
      "name": "Product 779180",
      "slug": "product-779180",
      "options_text": "Size: S",
      "price": "10.00",
      "total": "20.00",
      "adjustment_total": "0.00",
      "additional_tax_total": "0.00",
      "included_tax_total": "0.00",
      "discount_total": "0.00",
      "pre_tax_amount": "20.00",
      "discounted_amount": "20.00",
      "compare_at_amount": null,
      "thumbnail_url": null,
      "option_values": [
        {
          "id": "optval_UkLWZg9DAJ",
          "option_type_id": "opt_UkLWZg9DAJ",
          "name": "size-13",
          "label": "S",
          "position": 1,
          "color_code": null,
          "option_type_name": "foo-size-23",
          "option_type_label": "Size",
          "image_url": null,
          "metadata": {},
          "created_at": "2026-01-15T12:00:00.000Z",
          "updated_at": "2026-01-15T12:00:00.000Z"
        }
      ],
      "digital_links": [],
      "external_references": {},
      "metadata": {},
      "price_source": null,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "catalog_price": "19.99",
      "price_list_id": null,
      "price_list_name": null,
      "catalog_id": null,
      "catalog_name": null,
      "cost_price": "17.00",
      "tax_category_id": "taxcat_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Filters

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

Attribute	Kind	Predicates
`additional_tax_total`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`adjustment_total`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`cost_price`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`discount_total`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`included_tax_total`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`non_taxable_adjustment_total`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`order_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`pre_tax_amount`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`price`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`quantity`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`tax_category_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`taxable_adjustment_total`	Amount	`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`
`variant_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`

Filters through associations

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

Prefix	Attributes
`order_`	`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`
`order_bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`order_channel_`	`active`, `code`, `created_at`, `default`, `id`, `name`, `store_id`, `updated_at`
`order_customer_`	`accepts_email_marketing`, `created_at`, `email`, `first_name`, `id`, `last_name`, `phone`, `updated_at`
`order_fulfillments_`	`created_at`, `id`, `number`, `updated_at`
`order_order_group_`	`created_at`, `currency`, `email`, `id`, `number`, `updated_at`
`order_promotions_`	`code`, `created_at`, `expires_at`, `id`, `kind`, `name`, `path`, `promotion_category_id`, `starts_at`, `updated_at`
`order_seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`order_ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`order_shipments_`	`created_at`, `id`, `number`, `updated_at`
`order_store_`	`created_at`, `id`, `name`, `updated_at`
`order_tags_`	`created_at`, `id`, `name`, `updated_at`
`tax_category_`	`created_at`, `id`, `is_default`, `name`, `tax_code`, `updated_at`
`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`
`variant_option_values_`	`created_at`, `id`, `label`, `name`, `position`, `updated_at`
`variant_prices_`	`amount`, `compare_at_amount`, `created_at`, `currency`, `id`, `min_quantity`, `price_list_id`, `updated_at`, `variant_id`
`variant_product_`	`available_on`, `created_at`, `description`, `discontinue_on`, `id`, `name`, `price`, `seller_id`, `slug`, `status`, `updated_at`
`variant_seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`variant_tax_category_`	`created_at`, `id`, `is_default`, `name`, `tax_code`, `updated_at`

Sort by: 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. 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

Path Parameters

order_id

string

required

Order ID

Query Parameters

expand

string

Comma-separated associations to expand (e.g., variant, variant.product). Use dot notation for nested expand (max 4 levels).

fields

string

Comma-separated list of fields to include (e.g., quantity,price,total). id is always included.

object

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

Response

200 - application/json

items found

⌘I

API basics

Endpoints

Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

Filters