GET
/
v1
/
inventory
/
levels
/
total
List total inventory levels
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/inventory/levels/total \
  --header 'Authorization: Bearer <token>'
{
  "collection": [
    {
      "type": "TotalLevel",
      "product": {
        "type": "Product",
        "id": 5,
        "sku": "ABC123"
      },
      "qty_allocated": 15,
      "qty_backordered": 0,
      "qty_reserved": 7,
      "qty_picked": 2,
      "qty_expected": 100,
      "qty_processed": 0,
      "qty_putaway": 50,
      "qty_available": 166,
      "qty_on_hand": 230,
      "qty_advertised": 195,
      "updated_at": "2025-08-28T10:30:00Z"
    }
  ],
  "included": {
    "Product": [
      {
        "type": "Product",
        "id": 123,
        "vendor_sku": "Vendor-SKU-1AD2",
        "external_id": "11-993-9048",
        "barcodes": [
          "956623520-4",
          "O-VS-Oregano-p3"
        ],
        "goods_type": "NORMAL",
        "is_available": true,
        "is_visible": true,
        "lot_type": {
          "type": "LotType",
          "id": 4
        },
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "dimensions": {
          "length": 8,
          "width": 6,
          "height": 4,
          "unit": "in"
        },
        "volume": {
          "value": 300,
          "unit": "in^3"
        },
        "inventory": {
          "backorders": true,
          "dynamic_allocation": true,
          "virtual_inventory": "optimistic"
        },
        "export": {
          "description": "Plastic children's toy with steel weights and ball bearings",
          "customs_value": {
            "amount": 99,
            "currency": "USD"
          },
          "country_of_manufacture": "TW",
          "hs_base_code": "8518.30",
          "hs_country_extension": [
            {
              "country_id": "TW",
              "extension": "002"
            },
            {
              "country_id": "US",
              "extension": "011"
            }
          ]
        },
        "regulated_goods": {
          "regulation": {
            "type": "Regulation",
            "id": 123
          },
          "technical_name": "Hydro Polymer Acetylene Coating",
          "additional_information": "Flamable Liquid",
          "net_weight": {
            "value": 20,
            "unit": "lb"
          },
          "container_type": "Plastic Box",
          "container_meets_hazmat_specs": true,
          "regulation_units": 5
        },
        "packaging": {
          "require_packaging": true,
          "require_weight_check": true,
          "require_confirmation_per_item": true,
          "unit_quantity": 1,
          "bulk_quantity": 10,
          "max_per_package": 15,
          "is_ship_separately": true,
          "ship_separately_tag": "PVC",
          "can_tip": true,
          "can_contain_other_items": true,
          "is_handling_surcharge": true
        },
        "custom_fields": [
          {
            "code": "color",
            "value": 13,
            "label": "Red and Black"
          },
          {
            "code": "cost_of_goods",
            "value": 41.32
          },
          {
            "code": "allow_mailer",
            "value": true
          }
        ],
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ]
  },
  "has_more": true,
  "next": "<string>",
  "previous": "<string>",
  "meta": {
    "processing_time": 0.2525252525,
    "cursor_start": 123,
    "cursor_end": 123,
    "count": 123
  }
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Query Parameters

​
filter
string[]

Using the filtering syntax, you may filter the results using the following fields:

Product Fields:

  • product_id - Product entity ID
  • sku - Product SKU
  • product_name - Product name
  • product_type - Product type (normal, packaging, containers, supplies, infill)
  • product_created_at - Product creation date
  • product_updated_at - Product last update date
  • merchant_id - Merchant/website ID
  • vendor_sku - Vendor SKU
  • external_id - External product ID
  • barcode - Product barcode
  • goods_type - Goods classification
  • is_enabled - Product enabled status (default: true)
  • is_available - Product availability status
  • is_visible - Product visibility status

Inventory Fields:

  • updated_at - Inventory last updated timestamp
  • qty_allocated - Quantity allocated for orders
  • qty_backordered - Quantity backordered
  • qty_reserved - Quantity reserved for picking
  • qty_picked - Quantity picked but not packed
  • qty_expected - Quantity expected from deliveries
  • qty_processed - Quantity processed from deliveries
  • qty_putaway - Quantity waiting to be put away
  • qty_available - Quantity available for allocation
  • qty_on_hand - Total physical quantity on hand
  • qty_advertised - Quantity advertised to customers
​
sort
string

The default sort order is descending by updated_at (sort=-updated_at).

Using the sorting syntax, the following fields are available for sorting:

  • product_id
  • sku
  • updated_at
​
fields
enum<string>

Specify additional fields of the TotalLevel object to be included in the response.

Available options:
all,
product,
warehouse,
qty_allocated,
qty_backordered,
qty_reserved,
qty_picked,
qty_expected,
qty_processed,
qty_putaway,
qty_available,
qty_on_hand,
qty_advertised,
updated_at
​
fields:product
enum<string>[]

Specify additional fields of the Product or Packaging* object to be included in the response. See the selecting fields page for more information.

​
count
integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1
​
cursor_end
integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

​
cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

​
limit
integer
default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000
Example:

100

Response

200
application/json

A dictionary with a collection property that contains an array of up to limit TotalLevel objects. If no inventory levels are found the array will be empty.

The response is of type object.