List stock reservations

Spree Admin SDK

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

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

// Stock held for checkouts in progress, soonest to expire first.
const { data: reservations } = await client.stockReservations.list({
  sort: 'expires_at',
})

{
  "data": [
    {
      "id": "res_UkLWZg9DAJ",
      "stock_level_id": "sl_UkLWZg9DAJ",
      "line_item_id": "li_UkLWZg9DAJ",
      "order_id": "or_UkLWZg9DAJ",
      "variant_id": "variant_UkLWZg9DAJ",
      "stock_location_id": "sloc_UkLWZg9DAJ",
      "quantity": 1,
      "expires_at": "2026-01-15T12:10:00.000Z",
      "active": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

admin

stock_reservations

Spree Admin SDK

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

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

// Stock held for checkouts in progress, soonest to expire first.
const { data: reservations } = await client.stockReservations.list({
  sort: 'expires_at',
})

{
  "data": [
    {
      "id": "res_UkLWZg9DAJ",
      "stock_level_id": "sl_UkLWZg9DAJ",
      "line_item_id": "li_UkLWZg9DAJ",
      "order_id": "or_UkLWZg9DAJ",
      "variant_id": "variant_UkLWZg9DAJ",
      "stock_location_id": "sloc_UkLWZg9DAJ",
      "quantity": 1,
      "expires_at": "2026-01-15T12:10:00.000Z",
      "active": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z"
    }
  ],
  "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[created_at_eq]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`expires_at`	Date and time	`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`
`line_item_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`order_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`quantity`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`stock_level_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `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[line_item_id_eq]. The same predicates apply.

Prefix	Attributes
`line_item_`	`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_item_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`
`line_item_tax_category_`	`created_at`, `id`, `is_default`, `name`, `tax_code`, `updated_at`
`line_item_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_`	`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_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`
`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`
`stock_level_`	`allocated_count`, `count_on_hand`, `created_at`, `id`, `incoming_count`, `reserved_count`, `stock_location_id`, `updated_at`, `variant_id`
`stock_level_stock_location_`	`active`, `country_code`, `created_at`, `default`, `id`, `kind`, `name`, `pickup_enabled`, `returns_enabled`, `seller_id`, `state_code`, `updated_at`
`stock_level_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`

Sort by: created_at, expires_at, id, line_item_id, order_id, quantity, stock_level_id, 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

page

integer

Page number

limit

integer

Number of records per page

object

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

Response

200 - application/json

stock reservations found

data

object[]

required

Show child attributes

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters