Spree Admin SDK

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

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

const { data: stockLocations } = await client.stockLocations.list()

{
  "data": [
    {
      "id": "sloc_UkLWZg9DAJ",
      "name": "Brooklyn warehouse",
      "address1": "1600 Pennsylvania Ave NW",
      "city": "Washington",
      "zipcode": "20500",
      "country_code": "US",
      "country_name": "United States",
      "state_code": "AL",
      "state_text": "AL",
      "pickup_ready_in_minutes": null,
      "pickup_instructions": null,
      "external_references": {},
      "admin_name": null,
      "address2": null,
      "state_name": null,
      "phone": "(202) 456-1111",
      "company": null,
      "active": true,
      "default": false,
      "backorderable_default": true,
      "propagate_all_variants": false,
      "kind": "warehouse",
      "pickup_enabled": false,
      "pickup_stock_policy": "local",
      "returns_enabled": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "seller_id": null,
      "seller_name": 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"
  }
}

List stock locations

Returns the configured stock locations. Stock locations are global (shared across stores). Filter with Ransack predicates such as q[active_eq], q[kind_eq], q[pickup_enabled_eq], or q[name_cont].

Pickup-related attributes (kind, pickup_enabled, pickup_stock_policy, pickup_ready_in_minutes, pickup_instructions) drive merchant pickup support at checkout — customers can collect orders from any active location with pickup_enabled: true.

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

GET

api

admin

stock_locations

Spree Admin SDK

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

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

const { data: stockLocations } = await client.stockLocations.list()

{
  "data": [
    {
      "id": "sloc_UkLWZg9DAJ",
      "name": "Brooklyn warehouse",
      "address1": "1600 Pennsylvania Ave NW",
      "city": "Washington",
      "zipcode": "20500",
      "country_code": "US",
      "country_name": "United States",
      "state_code": "AL",
      "state_text": "AL",
      "pickup_ready_in_minutes": null,
      "pickup_instructions": null,
      "external_references": {},
      "admin_name": null,
      "address2": null,
      "state_name": null,
      "phone": "(202) 456-1111",
      "company": null,
      "active": true,
      "default": false,
      "backorderable_default": true,
      "propagate_all_variants": false,
      "kind": "warehouse",
      "pickup_enabled": false,
      "pickup_stock_policy": "local",
      "returns_enabled": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "seller_id": null,
      "seller_name": 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[name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`active`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`country_code`	One of the `CountryCode` codes	`eq` `not_eq` `in` `not_in` `null` `not_null`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`default`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`kind`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`pickup_enabled`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`returns_enabled`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`seller_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`state_code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`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[seller_id_eq]. The same predicates apply.

Prefix	Attributes
`seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`

Sort by: active, country_code, created_at, default, id, kind, name, pickup_enabled, returns_enabled, seller_id, state_code, 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 any of name (partial, case-insensitive).

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.

sort

string

Sort by field. Prefix with - for descending (e.g., -created_at).

fields

string

Comma-separated list of fields to include. id is always included.

Response

stock locations found

data

object[]

required

Show child attributes

API basics

Endpoints

List stock locations

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters