Inventory
Stock and availability lookups, scoped per location. Inventory is tracked at either the product or the variant level depending on the product’s `inventory_type`.
GET /api/v1/inventory/products/{product_id}/stock
Returns the on-hand stock for a product across one or more locations. Pass ?location_id=… to scope to a single location.
Request
curl "https://api.cimplify.io/api/v1/inventory/products/prod_abc123/stock?location_id=loc_01H…" \
-H "X-Public-Key: pk_test_your_publishable_key"Response
{
"success": true,
"data": {
"product_id": "prod_abc123",
"inventory_type": "tracked",
"locations": [
{
"location_id": "loc_01H…",
"quantity_on_hand": 42,
"quantity_reserved": 3,
"quantity_available": 39
}
]
}
}GET /api/v1/inventory/variants/{variant_id}/stock
Stock for a single variant. Same response shape as the product endpoint, with variant_id in place of product_id.
curl "https://api.cimplify.io/api/v1/inventory/variants/var_double/stock?location_id=loc_01H…" \
-H "X-Public-Key: pk_test_your_publishable_key"GET /api/v1/inventory/products/{product_id}/availability
Boolean check: can we sell quantity of this product at location_id right now? Pass ?quantity=… (required) and optionally ?location_id=….
Request
curl "https://api.cimplify.io/api/v1/inventory/products/prod_abc123/availability?quantity=2&location_id=loc_01H…" \
-H "X-Public-Key: pk_test_your_publishable_key"Response
{
"success": true,
"data": {
"product_id": "prod_abc123",
"is_available": true,
"quantity_requested": 2,
"quantity_available": 39
}
}GET /api/v1/inventory/variants/{variant_id}/availability
Same shape as the product availability endpoint, scoped to a variant.
curl "https://api.cimplify.io/api/v1/inventory/variants/var_double/availability?quantity=1&location_id=loc_01H…" \
-H "X-Public-Key: pk_test_your_publishable_key"Inventory types
| Type | Meaning |
|---|---|
none | No tracking; always available. |
tracked | Tracked at the product level. |
variant_level | Tracked per variant; product-level call returns null totals. |
Link
/v1/link/*: customer-scoped Link API. Hosted on api.cimplify.io, separate from the per-business storefront API.
Webhooks
Subscribe a server endpoint to lifecycle events emitted by Cimplify. Webhook administration is a server-side surface; all calls require a secret API key (`sk_…`) on `X-API-Key`.