Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Inventories

List Inventories

Retrieve a list of inventories. The list can be filtered, sorted, and paginated using the parameters below.

get/inventories

Query parameters

location_idinteger

The list returned will contain only inventories associated with the specified location.

product_variant_idinteger

The list returned will contain only inventories containing the specified product variant.

limitinteger

The maximum number of inventories returned.

sort_order'asc' | 'desc'

The sort order for the results.

cursorstring

The cursor to return the next page of results.

Response

Success

next_page_urlstring nullable
previous_page_urlstring nullable

Example response

{
  "inventories": [
    {
      "available_count": 42,
      "product_variant": {
        "id": 674353902539857400,
        "external_id": "ex4mpl3-pr0duct-v4r14nt",
        "sku": "EXAMPLEPRODUCT-VAR-1",
        "name": "Example Product",
        "weight_grams": 444
      },
      "location": {
        "id": 680118439701923300,
        "external_id": "main-warehouse",
        "name": "Main Warehouse",
        "address": {
          "name": "Main Warehouse",
          "company": "Universal Exports",
          "address1": "1234 Example Street",
          "address2": "Unit 19",
          "city": "Townsville",
          "region": "Louisiana",
          "country_code": "US"
        }
      }
    }
  ]
}