Inventory

Check product stock availability.

GET/api/v1/inventory/{product_id}/availability

Check Availability

Returns stock availability for a product, optionally filtered by location.

Path Parameters

Parameter	Type	Description
`product_id`	string	Product identifier (required)

Example Request

curl

curl https://storefront.cimplify.io/api/v1/inventory/prod_abc123/availability \
  -H "X-API-Key: pk_test_your_api_key"

Example Response

JSON

{
  "success": true,
  "data": {
    "product_id": "prod_abc123",
    "is_available": true,
    "inventory_type": "tracked",
    "variants": [
      {
        "variant_id": "var_small",
        "is_available": true,
        "quantity_available": 45
      },
      {
        "variant_id": "var_large",
        "is_available": false,
        "quantity_available": 0
      }
    ]
  }
}

Response Fields

Field	Type	Description
`product_id`	string	Product identifier
`is_available`	boolean	Whether any variant is in stock
`inventory_type`	string	none, tracked, or variant_level
`variants`	array	Per-variant availability (for tracked products)