Add Inventory

Add inventory to a product. Behavior differs based on the product's inventory tracking type.

Endpoint

POST /v1/products/{id}/inventory

Authentication

Requires an API key with the products:write scope.

Parameters

Parameter	Type	Location	Description
id	integer	path	The product ID

Request Body

Field	Type	Required	Description
variation_id	integer	Conditional	Required if product has variations enabled
identifier	string	Conditional	Item-level: the starting code for a numbered run. Required unless identifiers is provided; optional for group
identifiers	string[]	Conditional	Item-level only: an array of exact codes, one record each (saved verbatim). Use instead of identifier + quantity
quantity	integer	Conditional	Number of items to add. Required unless identifiers is provided
location	string	No	Free-text storage location
location_id	integer	No	Supplier location ID (see Locations)
available_from	string	No	Date when item becomes available (ISO 8601)
available_until	string	No	Date when item is no longer available (ISO 8601)

Tracking Type Behavior

Group-Level Tracking

For products with inventory_tracking: "group":

• Creates a single inventory record with the specified quantity
• Merges into existing record if same variation + location + available dates match
• identifier is optional

Item-Level Tracking

For products with inventory_tracking: "item", creates individual records (each with total_quantity: 1). Provide either identifier + quantity or an identifiers array:

• Numbered run (identifier + quantity): continues the number at the end of the code you send, preserving its zero-padding. identifier: "EXO-0001", quantity: 17 creates EXO-0001 … EXO-0017. A quantity of 1 saves the code exactly as sent (no suffix). A code with no trailing number falls back to {identifier}-1, {identifier}-2, ...
• Exact list (identifiers): each string is saved verbatim as its own item — use this for serial numbers.
• The -N suffix only ever appears to avoid a clash. Numbers already in use are skipped; an exact code that already exists returns a 422 validation error and nothing is created.

Response

Group-Level Tracking (201 Created)

{
  "data": {
    "id": 5,
    "variation": {
      "id": 1,
      "sku": "BIKE-L-RED",
      "values": "Large, Red"
    },
    "identifier": null,
    "unique_identifier": null,
    "increment": null,
    "total_quantity": 10,
    "location": "Warehouse A",
    "supplier_location": {
      "id": 1,
      "name": "Main Store"
    },
    "available_from": null,
    "available_until": null,
    "status": "current",
    "created_at": "2026-02-01T10:00:00+00:00",
    "updated_at": "2026-02-01T10:00:00+00:00"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-01T10:00:00+00:00"
  }
}

Item-Level Tracking (201 Created)

Returns array of created items:

{
  "data": {
    "message": "Created 3 inventory item(s).",
    "items": [
      {
        "id": 10,
        "variation": null,
        "identifier": "BIKE-1",
        "unique_identifier": "BIKE",
        "increment": 1,
        "total_quantity": 1,
        "location": "Main Store",
        "supplier_location": {
          "id": 1,
          "name": "Main Store"
        },
        "available_from": null,
        "available_until": null,
        "status": "current",
        "created_at": "2026-02-01T10:00:00+00:00",
        "updated_at": "2026-02-01T10:00:00+00:00"
      },
      {
        "id": 11,
        "identifier": "BIKE-2",
        "unique_identifier": "BIKE",
        "increment": 2,
        ...
      },
      {
        "id": 12,
        "identifier": "BIKE-3",
        "unique_identifier": "BIKE",
        "increment": 3,
        ...
      }
    ]
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-01T10:00:00+00:00"
  }
}

Example Requests

Group-Level: Add Stock Quantity

curl -X POST "https://app.equipdash.com/api/v1/products/1/inventory" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "variation_id": 1,
    "quantity": 10,
    "location": "Warehouse A",
    "location_id": 1
  }'

Group-Level: Add Expected Stock

curl -X POST "https://app.equipdash.com/api/v1/products/1/inventory" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "variation_id": 1,
    "quantity": 5,
    "available_from": "2026-03-01T00:00:00Z"
  }'

Item-Level: Add Individual Items

curl -X POST "https://app.equipdash.com/api/v1/products/2/inventory" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "KAYAK",
    "quantity": 3,
    "location": "Dock Storage"
  }'

This creates 3 items: KAYAK-1, KAYAK-2, KAYAK-3

Item-Level: With Variation

curl -X POST "https://app.equipdash.com/api/v1/products/2/inventory" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "variation_id": 5,
    "identifier": "KAYAK-RED",
    "quantity": 2
  }'

Errors

Status	Code	Description
401	authentication_required	No API key provided
403	insufficient_scope	API key lacks products:write scope
404	resource_not_found	Product not found
422	validation_error	Invalid request data

Common Validation Errors

Error	Description
product: Inventory tracking not enabled	Enable inventory tracking on the product first
variation_id: required	Product has variations - must specify which variation
identifier: required	Item-level tracking requires an identifier
variation_id: does not belong to product	The variation ID doesn't exist for this product
quantity: required	Must specify quantity
available_until: must be after available_from	End date must be after start date