API Reference

Catalog

View the Roastify catalog, including products and coffee blends

GET/v1/catalog/products

Get All Products

Get all available products in the catalog

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
200Get all available products in the catalog
400Returns an error
401Unauthorized
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/catalog/products"

[
  {
    "id": "clyd67824rn3f78g0f8j9",
    "title": "12oz Coffee Box",
    "description": "string",
    "imageUrl": "https://acme.com/12oz-coffee-bag.png",
    "productType": "12ozCoffeeBox",
    "productCategory": "Coffee",
    "dielineTemplateUrl": "https://acme.com/12oz-coffee-bag-dieline.png",
    "variants": 8,
    "plan": "pro"
  }
]

GET/v1/catalog/products/{id}

Get Product by ID

Get a catalog product by 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 product by Id in the catalog
400Returns an error
401Unauthorized
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/catalog/products/clyd67824rn3f78g0f8j9"

{
  "id": "clyd67824rn3f78g0f8j9",
  "title": "12oz Coffee Box",
  "description": "string",
  "imageUrl": "https://acme.com/12oz-coffee-bag.png",
  "productType": "12ozCoffeeBox",
  "productCategory": "Coffee",
  "dielineTemplateUrl": "https://acme.com/12oz-coffee-bag-dieline.png",
  "variants": 8,
  "plan": "pro"
}

GET/v1/catalog/blends

Get All Coffee Blends

Get all availalbe blends in the catalog. This does not include custom blends or discontinued blends

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
200Get all availalbe blends in the catalog
400Returns an error
401Unauthorized
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/catalog/blends"

[
  {
    "id": "clyd67824rn3f78g0f8j9",
    "name": "12oz Coffee Bag",
    "description": "string",
    "isDecaf": false,
    "roastLevel": "Medium"
  }
]

GET/v1/catalog/blends/{id}

Get Coffee Blend by ID

Get a coffee blend by 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 blend by Id
400Returns an error
401Unauthorized
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/catalog/blends/clyd67824rn3f78g0f8j9"

{
  "id": "clyd67824rn3f78g0f8j9",
  "name": "12oz Coffee Bag",
  "description": "string",
  "isDecaf": false,
  "roastLevel": "Medium"
}

Previous

Get Started

Next

Orders