List Stock Locations

Retrieve a list of stock locations. The stock locations can be filtered by fields such as name or created_at. The stock locations can also be sorted or paginated.

Request

Query Params

string

optional

Filter by ID.

name

string

optional

Filter by name.

order

string

optional

A stock-location field to sort-order the retrieved stock locations by.

array[string]

optional

filter by dates less than this date

Example:

["","",""]

array[string]

optional

filter by dates greater than this date

Example:

["","",""]

lte

array[string]

optional

filter by dates less than or equal to this date

Example:

["","",""]

gte

array[string]

optional

filter by dates greater than or equal to this date

Example:

["","",""]

offset

integer

optional

The number of stock locations to skip when retrieving the stock locations.

limit

integer

optional

Limit the number of stock locations returned.

expand

string

optional

Comma-separated relations that should be expanded in the returned stock locations.

fields

string

optional

Comma-separated fields that should be included in the returned stock locations.

Responses

🟢200OK

application/json

Body

count

integer

required

The total number of items available

offset

integer

required

The number of stock locations skipped when retrieving the stock locations.

limit

integer

required

The number of items per page

stock_locations

array[object (StockLocationExpandedDTO) {9}]

required

string

required

The stock location's ID

Example:

sloc_51G4ZW853Y6TFXWPG5ENJ81X42

address_id

string

required

Stock location address' ID

Example:

laddr_05B2ZE853Y6FTXWPW85NJ81A44

name

string

required

The name of the stock location

Example:

Main Warehouse

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time>

optional

The date with timezone at which the resource was deleted.

metadata

object

optional

An optional key-value map with additional details

Example:

{"car":"white"}

address

object

optional

The Address of the Stock Location

sales_channels

object

Sales Channel

optional

A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.

Example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "stock_locations": [
    {
      "id": "sloc_51G4ZW853Y6TFXWPG5ENJ81X42",
      "address_id": "laddr_05B2ZE853Y6FTXWPW85NJ81A44",
      "name": "Main Warehouse",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "metadata": {
        "car": "white"
      },
      "address": {
        "id": "laddr_51G4ZW853Y6TFXWPG5ENJ81X42",
        "address_1": "35, Jhon Doe Ave",
        "address_2": "apartment 4432",
        "company": "Medusa",
        "city": "Mexico city",
        "country_code": "MX",
        "phone": "+1 555 61646",
        "postal_code": "HD3-1G8",
        "province": "Sinaloa",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
          "car": "white"
        }
      },
      "sales_channels": {
        "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
        "name": "Market",
        "description": "Multi-vendor market",
        "is_disabled": false,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
          "car": "white"
        },
        "locations": [
          {
            "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
            "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
            "location_id": "string",
            "sales_channel": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z"
          }
        ]
      }
    }
  ]
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

List Stock Locations

Request

Request samples

Responses