Talk to an Expert
List inventory - Grasshopper Labs API
DocsInventoryList
Inventory

List inventory

Paginated list of inventory records.

GET /api/inventory/

Query parameters

sku
string Optional
Filter by SKU. Supports partial match.
location_id
string Optional
Filter by hub/warehouse location.
min_quantity
integer Optional
Only return items with quantity >= this value.
page
integer Optional
Page number. Defaults to 1.
per_page
integer Optional
Results per page. Max 100.
curl -G https://{licensee-url}/api/inventory/ \
  -H "Authorization: Bearer $TOKEN" \
  -d "location_id=hub-atl-01" \
  -d "min_quantity=1"
{
  "data": [
    {
      "inventory_id": "inv_abc123",
      "sku": "SOFA-001",
      "name": "3-Seat Sofa",
      "location_id": "hub-atl-01",
      "quantity": 42,
      "reserved": 8,
      "available": 34
    }
  ],
  "pagination": { "page": 1, "total": 1247 }
}
Try it out
Response will appear here
← Previous
Inventory overview