Skip to main content
GET
/
admin
/
inventory
List Inventory
curl --request GET \
  --url https://api.headlesscommerce.io/v1/admin/inventory \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "variant_id": "<string>",
      "track_inventory": true,
      "allow_backorder": true,
      "safety_stock": 123,
      "on_hand": 123,
      "reserved": 123,
      "available": 123,
      "metadata": {}
    }
  ],
  "total_count": 123,
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
starting_after
string

Return results after this ID (cursor)

low_stock
boolean

If true, returns only items below safety stock

Response

200 - application/json

Success

data
object[]
total_count
integer

Only returned in Admin API

has_more
boolean
next_cursor
string | null