GET
/
admin
/
stock-locations
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.stockLocation.list()
.then(({ stock_locations, count, limit, offset }) => {
  console.log(stock_locations)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "stock_locations": [
    {
      "id": "<string>",
      "name": "<string>",
      "address_id": "<string>",
      "address": {
        "id": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "company": "<string>",
        "country_code": "us",
        "city": "<string>",
        "phone": "<string>",
        "postal_code": "<string>",
        "province": "us-ca"
      },
      "sales_channels": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "is_disabled": true,
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ],
      "fulfillment_providers": [
        {
          "id": "<string>",
          "is_enabled": true
        }
      ],
      "fulfillment_sets": [
        {}
      ]
    }
  ],
  "estimate_count": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
q
string

Search term to filter the stock location's searchable properties.

​
id

Filter by a stock location ID.

​
name

Filter by a stock location name.

​
address_id

Filter by an address ID to retrieve its associated locations.

​
sales_channel_id

Filter by a sales channel ID to retrieve its associated locations.

​
created_at
object

Filter by a stock location's creation date.

​
updated_at
object

Filter by a stock location's update date.

​
deleted_at
object

Filter by a stock location's deletion date.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The paginated list of stock locations.