Skip to main content
GET
/
v1
/
stock
/
{sku}
Get Stock By SKU
curl --request GET \
  --url https://api.roastify.app/v1/stock/{sku} \
  --header 'x-api-key: <api-key>'
{
  "sku": "COF-GND-12O-FHV-BOX",
  "stockQty": 100,
  "inStock": true
}

Authorizations

​
x-api-key
string
header
required

The API key to authenticate requests provided by Roastify. A Base or Pro plan is required to use the API.

Path Parameters

​
sku
string
required

The SKU of the resource

Minimum string length: 1
Example:

"COF-WHB-12O-FHV-BOX"

Response

Returns the stock status and quantity of a variant

​
sku
string
required

The SKU of the variant

Example:

"COF-GND-12O-FHV-BOX"

​
stockQty
number
required

The stock quantity of the variant. If the quantity is 999, it means the stock is considered unlimited.

Example:

100

​
inStock
boolean
required

Boolean indicating whether the variant is in stock

Example:

true