Skip to content

List a product's stock levels, one row per live outlet

Open in ClaudeOpen in ChatGPTView as Markdown
GET
/products/{id}/inventory

Never includes average_cost or total_cost. Quantities are numbers, up to 3 decimal places.

  • 404 NOT_FOUND: the product id is foreign, unknown, or deleted.

Requires scope: inventory:read

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

List a product’s stock levels, one row per live outlet

Media typeapplication/json
object
data
required
Array<object>
object
on_hand
required

Current stock level. Up to 3 decimal places.

number
outlet_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
reorder_amount
required
number | null
reorder_method
required
string
reorder_point
required
number | null
reorder_target
required
number | null
version
required

Delta-sync version, as a string (bigint).

string
Examplegenerated
{
  "data": [
    {
      "on_hand": 1,
      "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "reorder_amount": 1,
      "reorder_method": "example",
      "reorder_point": 1,
      "reorder_target": 1,
      "version": "example"
    }
  ]
}

default

Section titled “default”

An error response.

Media typeapplication/json
object
error
required
object
code
required

A machine-readable error code, e.g. VALIDATION_FAILED.

string
Allowed values: UNAUTHORIZED PLAN_REQUIRED INSUFFICIENT_SCOPE NOT_FOUND VALIDATION_FAILED CONFLICT STALE_VERSION RATE_LIMITED IDEMPOTENCY_KEY_REUSED IDEMPOTENCY_IN_PROGRESS IMAGE_FETCH_FAILED UNPROCESSABLE INTERNAL RETAILER_CANCELLED RETAILER_SUSPENDED RETAILER_NOT_FOUND TRIAL_DECISION_REQUIRED PLAN_USERS_EXCEEDED RETAILER_PAUSED PRODUCT_LIMIT_REACHED NOT_STOCK_TRACKED REASON_DIRECTION_MISMATCH REASON_NOT_ALLOWED INSUFFICIENT_STOCK OUTLET_DELETED
fields
Array<object>
object
field
required
string
message
required
string
message
required

A plain-English sentence describing what went wrong.

string
Example
{
  "error": {
    "code": "UNAUTHORIZED"
  }
}