Skip to main content
GET
/
v3
/
stores
/
{store_id}
/
public
/
variants
/
{variant_id}
/
availability
Get storefront variant inventory availability
curl --request GET \
  --url https://api.scalev.com/v3/stores/{store_id}/public/variants/{variant_id}/availability \
  --header 'X-Scalev-Storefront-Api-Key: <x-scalev-storefront-api-key>'
{
  "variant_id": 123,
  "available": true,
  "available_qty": 1,
  "stock_status": "in_stock"
}

Headers

​
X-Scalev-Storefront-Api-Key
string
required

Publishable storefront public API key for the target store.

Path Parameters

​
store_id
string
required

Store unique_id.

​
variant_id
string
required

Response

Variant availability

​
variant_id
required
​
available
boolean
required
​
available_qty
integer | null
required

Null for non-inventory variants with unlimited availability.

Required range: x >= 0
​
stock_status
enum<string>
required
Available options:
in_stock,
low_stock,
out_of_stock