List Inventory

Get all inventory items for a product.

Endpoint

GET /v1/products/{id}/inventory

Authentication

Requires an API key with the products:read scope.

Parameters

Parameter	Type	Location	Description
id	integer	path	The product ID

Query Parameters

Parameter	Type	Description
variation_id	integer	Filter by variation
status	string	Filter by status: current, expected, expired
location_id	integer	Filter by supplier location ID (see Locations)

Response

Success (200 OK)

{
  "data": {
    "product_id": 1,
    "inventory_tracking": "item",
    "items": [
      {
        "id": 1,
        "variation": {
          "id": 1,
          "sku": "BIKE-L-RED",
          "values": [
            { "property": "Size", "value": "Large" },
            { "property": "Color", "value": "Red" }
          ]
        },
        "identifier": "Bike #1",
        "unique_identifier": "SN-001",
        "increment": 1,
        "total_quantity": 1,
        "location": "Warehouse A",
        "supplier_location": {
          "id": 1,
          "name": "Main Store"
        },
        "available_from": null,
        "available_until": null,
        "status": "current",
        "created_at": "2026-01-15T10:00:00+00:00",
        "updated_at": "2026-01-15T10:00:00+00:00"
      },
      {
        "id": 2,
        "variation": null,
        "identifier": "Bike #2",
        "unique_identifier": "SN-002",
        "increment": 2,
        "total_quantity": 1,
        "location": "Warehouse A",
        "supplier_location": null,
        "available_from": "2026-03-01T00:00:00+00:00",
        "available_until": null,
        "status": "expected",
        "created_at": "2026-01-15T10:00:00+00:00",
        "updated_at": "2026-01-15T10:00:00+00:00"
      }
    ]
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-01T10:00:00+00:00"
  }
}

Example Requests

List All Inventory

curl -X GET "https://app.equipdash.com/api/v1/products/1/inventory" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filter by Status

curl -X GET "https://app.equipdash.com/api/v1/products/1/inventory?status=current" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filter by Variation

curl -X GET "https://app.equipdash.com/api/v1/products/1/inventory?variation_id=1" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filter by Location

curl -X GET "https://app.equipdash.com/api/v1/products/1/inventory?location_id=1" \
  -H "Authorization: Bearer YOUR_API_KEY"

Errors

Status	Code	Description
401	authentication_required	No API key provided
403	insufficient_scope	API key lacks products:read scope
404	resource_not_found	Product not found