Get Stock List

Get Stock List

curl --request GET \
  --url https://api.roastify.app/v1/stock \
  --header 'x-api-key: <api-key>'

[
  {
    "sku": "COF-GND-12O-FHV-BOX",
    "stockQty": 100,
    "inStock": true
  }
]

GET

stock

Get Stock List

curl --request GET \
  --url https://api.roastify.app/v1/stock \
  --header 'x-api-key: <api-key>'

[
  {
    "sku": "COF-GND-12O-FHV-BOX",
    "stockQty": 100,
    "inStock": true
  }
]

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.

Returns the stock list

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

⌘I