List stock locations

Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

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

{
  "data": [
    {
      "id": "sloc_UkLWZg9DAJ",
      "name": "Lesha Stroman",
      "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,
      "address2": null,
      "state_name": null,
      "phone": "(202) 456-1111",
      "company": null,
      "active": true,
      "default": false,
      "kind": "warehouse",
      "returns_enabled": 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

seller

stock_locations

Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

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

{
  "data": [
    {
      "id": "sloc_UkLWZg9DAJ",
      "name": "Lesha Stroman",
      "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,
      "address2": null,
      "state_name": null,
      "phone": "(202) 456-1111",
      "company": null,
      "active": true,
      "default": false,
      "kind": "warehouse",
      "returns_enabled": 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[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`

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

Authorization

string

header

required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id

string

required

Query Parameters

q[search]

string

Matches any of name (partial, case-insensitive).

page

integer

Page number

limit

integer

Records per page (max 100)

sort

string

Sort field; prefix with - for descending

object

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

Response

200 - application/json

stock locations listed

data

object[]

required

Show child attributes

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters