Skip to main content
GET
/
api
/
v3
/
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",
      "state_abbr": "STATE_ABBR_22",
      "name": "Brooklyn warehouse",
      "address1": "1600 Pennsylvania Ave NW",
      "city": "Washington",
      "zipcode": "20500",
      "country_iso": "US",
      "country_name": "United States of America",
      "state_text": "STATE_ABBR_22",
      "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",
      "pickup_ready_in_minutes": null,
      "pickup_instructions": null,
      "created_at": "2026-05-17T22:58:21.908Z",
      "updated_at": "2026-05-17T22:58:21.908Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

​
q[name_cont]
string

Filter by name (contains)

​
q[active_eq]
boolean

Filter by active status

​
q[kind_eq]
string

Filter by kind (built-in: 'warehouse', 'store', 'fulfillment_center')

​
q[pickup_enabled_eq]
boolean

Filter by pickup-enabled flag

​
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
​
meta
object
required