List Inventories

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

GET /inventories

List Inventories

cURL

curl --request GET \
  --url https://api.loopreturns.com/api/v1/inventories \
  --header 'X-Authorization: <api-key>'

200

{
  "inventories": [
    {
      "available_count": 123,
      "product_variant": [
        {
          "id": 123,
          "external_id": "<string>",
          "sku": "<string>",
          "name": "<string>",
          "weight_grams": 123,
          "barcode": "<string>"
        }
      ],
      "location": [
        {
          "id": 123,
          "external_id": "<string>",
          "name": "<string>",
          "address": [
            {
              "name": "<string>",
              "company": "<string>",
              "address1": "<string>",
              "address2": "<string>",
              "city": "<string>",
              "region": "<string>",
              "postal_code": "<string>",
              "country_code": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "next_page_url": "<string>",
  "previous_page_url": "<string>"
}

Authorizations

X-Authorization · string · header · required

API Scope: "Inventory (read)"

Query Parameters

location_id · integer

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

product_variant_id · integer

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

limit · integer · default: 50

The maximum number of inventories returned.

Required range: 1 <= x <= 250

sort_order · enum<string> · default: asc

The sort order for the results.

Available options: asc, desc

cursor · string

The cursor to return the next page of results.

Response

200

application/json

Success

inventories · object[]

An array of inventories.

Show child attributes

next_page_url · string

previous_page_url · string