Spree Admin SDK

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

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

// One row per variant per location: on hand, committed, reserved, available
// and incoming, with the variant and location named flat on the row.
const { data: stockLevels } = await client.stockLevels.list({
  stock_location_id_eq: 'sloc_xxx',
})

{
  "data": [
    {
      "id": "sl_UkLWZg9DAJ",
      "count_on_hand": 0,
      "backorderable": true,
      "stock_location_id": "sloc_UkLWZg9DAJ",
      "variant_id": "variant_UkLWZg9DAJ",
      "external_references": {},
      "metadata": {},
      "reserved_count": 0,
      "incoming_count": 0,
      "purchasable_count": 0,
      "variant_name": "Product 1885410",
      "variant_sku": "SKU-233",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "stock_location_name": "Jong Schamberger",
      "product_id": "prod_UkLWZg9DAJ",
      "options_text": null,
      "thumbnail_url": null,
      "allocated_count": 0,
      "available_count": 0
    },
    {
      "id": "sl_gbHJdmfrXB",
      "count_on_hand": 0,
      "backorderable": true,
      "stock_location_id": "sloc_UkLWZg9DAJ",
      "variant_id": "variant_gbHJdmfrXB",
      "external_references": {},
      "metadata": {},
      "reserved_count": 0,
      "incoming_count": 0,
      "purchasable_count": 0,
      "variant_name": "Product 1885410",
      "variant_sku": "SKU-234",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "stock_location_name": "Jong Schamberger",
      "product_id": "prod_UkLWZg9DAJ",
      "options_text": "Size: S",
      "thumbnail_url": null,
      "allocated_count": 0,
      "available_count": 0
    },
    {
      "id": "sl_EfhxLZ9ck8",
      "count_on_hand": 40,
      "backorderable": true,
      "stock_location_id": "sloc_gbHJdmfrXB",
      "variant_id": "variant_gbHJdmfrXB",
      "external_references": {},
      "metadata": {},
      "reserved_count": 2,
      "incoming_count": 20,
      "purchasable_count": 35,
      "variant_name": "Product 1885410",
      "variant_sku": "SKU-234",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "stock_location_name": "Pilar Stokes",
      "product_id": "prod_UkLWZg9DAJ",
      "options_text": "Size: S",
      "thumbnail_url": null,
      "allocated_count": 3,
      "available_count": 37
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 3,
    "pages": 1,
    "from": 1,
    "to": 3,
    "in": 3,
    "previous": null,
    "next": null
  }
}

List stock levels

One row per variant per stock location, carrying every figure the Inventory page shows: count_on_hand (on hand), allocated_count (committed to placed orders), reserved_count (held by checkouts in progress), available_count (on hand minus committed) and incoming_count (on its way on an open purchase order or a transfer in transit). The variant and location are named flat on the row (variant_name, variant_sku, stock_location_name, thumbnail_url) so a list needs no expansion.

Filter with q[stock_location_id_eq], q[variant_id_eq] or q[variant_sku_or_variant_product_name_cont].

Required scope: read_stock (for API-key authentication).

GET

api

admin

stock_levels

Spree Admin SDK

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

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

// One row per variant per location: on hand, committed, reserved, available
// and incoming, with the variant and location named flat on the row.
const { data: stockLevels } = await client.stockLevels.list({
  stock_location_id_eq: 'sloc_xxx',
})

{
  "data": [
    {
      "id": "sl_UkLWZg9DAJ",
      "count_on_hand": 0,
      "backorderable": true,
      "stock_location_id": "sloc_UkLWZg9DAJ",
      "variant_id": "variant_UkLWZg9DAJ",
      "external_references": {},
      "metadata": {},
      "reserved_count": 0,
      "incoming_count": 0,
      "purchasable_count": 0,
      "variant_name": "Product 1885410",
      "variant_sku": "SKU-233",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "stock_location_name": "Jong Schamberger",
      "product_id": "prod_UkLWZg9DAJ",
      "options_text": null,
      "thumbnail_url": null,
      "allocated_count": 0,
      "available_count": 0
    },
    {
      "id": "sl_gbHJdmfrXB",
      "count_on_hand": 0,
      "backorderable": true,
      "stock_location_id": "sloc_UkLWZg9DAJ",
      "variant_id": "variant_gbHJdmfrXB",
      "external_references": {},
      "metadata": {},
      "reserved_count": 0,
      "incoming_count": 0,
      "purchasable_count": 0,
      "variant_name": "Product 1885410",
      "variant_sku": "SKU-234",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "stock_location_name": "Jong Schamberger",
      "product_id": "prod_UkLWZg9DAJ",
      "options_text": "Size: S",
      "thumbnail_url": null,
      "allocated_count": 0,
      "available_count": 0
    },
    {
      "id": "sl_EfhxLZ9ck8",
      "count_on_hand": 40,
      "backorderable": true,
      "stock_location_id": "sloc_gbHJdmfrXB",
      "variant_id": "variant_gbHJdmfrXB",
      "external_references": {},
      "metadata": {},
      "reserved_count": 2,
      "incoming_count": 20,
      "purchasable_count": 35,
      "variant_name": "Product 1885410",
      "variant_sku": "SKU-234",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "stock_location_name": "Pilar Stokes",
      "product_id": "prod_UkLWZg9DAJ",
      "options_text": "Size: S",
      "thumbnail_url": null,
      "allocated_count": 3,
      "available_count": 37
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 3,
    "pages": 1,
    "from": 1,
    "to": 3,
    "in": 3,
    "previous": null,
    "next": null
  }
}

Filters

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

Attribute	Kind	Predicates
`allocated_count`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`count_on_hand`	Number	`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`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`incoming_count`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`reserved_count`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`stock_location_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`
`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[stock_location_id_eq]. The same predicates apply.

Prefix	Attributes
`stock_location_`	`active`, `country_code`, `created_at`, `default`, `id`, `kind`, `name`, `pickup_enabled`, `returns_enabled`, `seller_id`, `state_code`, `updated_at`
`stock_location_seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `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: allocated_count, count_on_hand, created_at, id, incoming_count, reserved_count, stock_location_id, 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

Query Parameters

q[search]

string

Matches any of variant sku and variant product name (partial, case-insensitive).

q[with_stock_status][]

string[]

Applies with_stock_status to the given value.

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 levels found

data

object[]

required

Show child attributes

API basics

Endpoints

List stock levels

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters