API Reference

Variants

Get variant information for Roastify products and blends.

GET/v1/variants/{sku}

Get Variant by SKU

Get 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
200Get a variant by SKU
400Returns an error
401Unauthorized
404Not Found
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/variants/COF-WHB-12O-FHV-BOX"

{
  "id": "clyd67824rn3f78g0f8j9",
  "title": "12oz Coffee Box",
  "size": "string",
  "color": "string",
  "retailPrice": 0,
  "sku": "COF-GND-12O-COL-BOX",
  "inStock": true,
  "stockQty": 999
}

GET/v1/variants/product/{id}

Get Variants by Product ID

Get all variants for a product by using the product's Id

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

id
Required
string

The Id of the resource

Example: "clyd67824rn3f78g0f8j9"Minimum length: 1
Status codeDescription
200Get a variant by Id
400Returns an error
401Unauthorized
404Not Found
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/variants/product/clyd67824rn3f78g0f8j9"

[
  {
    "id": "clyd67824rn3f78g0f8j9",
    "title": "12oz Coffee Box",
    "size": "string",
    "color": "string",
    "retailPrice": 0,
    "sku": "COF-GND-12O-COL-BOX",
    "inStock": true,
    "stockQty": 999
  }
]

GET/v1/variants/blend/{id}

Get Variants by Blend ID

Get all variants for a blend by using the blend's Id

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

id
Required
string

The Id of the resource

Example: "clyd67824rn3f78g0f8j9"Minimum length: 1
Status codeDescription
200All variants for a blend
400Returns an error
401Unauthorized
404Not Found
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/variants/blend/clyd67824rn3f78g0f8j9"

[
  {
    "id": "clyd67824rn3f78g0f8j9",
    "title": "12oz Coffee Box",
    "size": "string",
    "color": "string",
    "retailPrice": 0,
    "sku": "COF-GND-12O-COL-BOX",
    "inStock": true,
    "stockQty": 999
  }
]

Previous

Transactions