Skip to main content
GET
/
api
/
v1
/
inventory_levels.json
List Inventory Levels
curl --request GET \
  --url https://api.launchmystore.io/api/v1/inventory_levels.json \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data.items": [
    {
      "inventory_item_id": "<string>",
      "location_id": "<string>",
      "variant_id": "<string>",
      "sku": "<string>",
      "available": 123,
      "incoming": 123,
      "committed": 123,
      "on_hand": 123,
      "updated_at": "<string>"
    }
  ],
  "data.pagination": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.launchmystore.io/llms.txt

Use this file to discover all available pages before exploring further.

​
List Inventory Levels

Returns inventory levels for product variants across all locations.

​
Request

curl -X GET "https://api.launchmystore.io/api/v1/inventory_levels" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Parameters

​
page
integer
default:"1"
Page number for pagination
​
limit
integer
default:"50"
Number of items per page (max 250)
​
location_id
string
Filter by inventory location ID
​
inventory_item_ids
string
Comma-separated list of inventory item IDs to retrieve
​
variant_ids
string
Comma-separated list of variant IDs to retrieve
​
updated_at_min
string
Filter inventory updated after this date (ISO 8601)

​
Response

​
success
boolean
Whether the request succeeded
​
data.items
array
Array of inventory level objects
​
data.pagination
object
Pagination information

​
Example Response

{
  "success": true,
  "data": {
    "items": [
      {
        "inventory_item_id": "inv_abc123",
        "location_id": "loc_main",
        "variant_id": "var_xyz789",
        "sku": "TSHIRT-S-BLK",
        "available": 45,
        "incoming": 100,
        "committed": 5,
        "on_hand": 50,
        "updated_at": "2024-01-20T14:45:00Z"
      },
      {
        "inventory_item_id": "inv_def456",
        "location_id": "loc_main",
        "variant_id": "var_abc123",
        "sku": "TSHIRT-M-BLK",
        "available": 30,
        "incoming": 0,
        "committed": 10,
        "on_hand": 40,
        "updated_at": "2024-01-20T14:45:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 500,
      "hasMore": true
    }
  }
}

​
Inventory Quantities Explained

FieldDescription
on_handTotal physical inventory at the location
committedReserved for unfulfilled orders
incomingExpected from purchase orders or transfers
availableCan be sold (on_hand - committed)

​
Error Codes

CodeDescription
UNAUTHORIZEDInvalid or missing access token
FORBIDDENApp doesn’t have read_inventory scope