List Inventory Level

Retrieve a list of inventory levels of an inventory item. The inventory levels can be filtered by fields such as location_id. The inventory levels can also be paginated.

Request

Path Params

string

required

The ID of the Inventory Item the locations are associated with.

Query Params

location_id

array[string]

optional

Filter by location IDs.

expand

string

optional

Comma-separated relations that should be expanded in the returned inventory levels.

fields

string

optional

Comma-separated fields that should be included in the returned inventory levels.

Responses

🟢200OK

application/json

Body

inventory_item

object

required

string

required

location_levels

array[object (InventoryLevelDTO) {8}]

required

List of stock levels at a given location

Example

{
  "inventory_item": {
    "id": "string",
    "location_levels": [
      {
        "location_id": "string",
        "stocked_quantity": 0,
        "reserved_quantity": 0,
        "incoming_quantity": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
          "car": "white"
        }
      }
    ]
  }
}

🟠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 Inventory Level

Request

Request samples

Responses