API Reference

Stock

Get stock levels for Roastify products and SKUs

GET/v1/stock

Get Stock List

Get the stock status and quantity of all available variants

Authorization

x-api-key
Required
<token>

The API key to authenticate requests provided by Roastify. If you do not have an API key, please contact [email protected]

In: header

Status codeDescription
200Returns the stock list
400Returns an error
401Unauthorized
404Not Found
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/stock"

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

GET/v1/stock/{sku}

Get Stock By SKU

Get the stock status and quantity of a variant by SKU

Authorization

x-api-key
Required
<token>

The API key to authenticate requests provided by Roastify. If you do not have an API key, please contact [email protected]

In: header

Path Parameters

sku
Required
string

The SKU of the resource

Example: "COF-WHB-12O-FHV-BOX"Minimum length: 1
Status codeDescription
200Returns the stock status and quantity of a variant
400Returns an error
401Unauthorized
404Not Found
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/stock/COF-WHB-12O-FHV-BOX"

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

Previous

Orders

Next

Transactions