GET
/
v1
/
catalog
/
products
curl --request GET \
  --url https://api.roastify.app/v1/catalog/products \
  --header 'x-api-key: <api-key>'
[
  {
    "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"
  }
]

Authorizations

​
x-api-key
string
header
required

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

Response

200
application/json
Get all available products in the catalog
​
id
string
required

The id of the product

Example:

"clyd67824rn3f78g0f8j9"

​
title
string
required

The title of the product

Example:

"12oz Coffee Box"

​
description
string
required

The description of the product

​
imageUrl
string
required

The image url of the product

Example:

"https://acme.com/12oz-coffee-bag.png"

​
productType
string
required

The type of the product

Example:

"12ozCoffeeBox"

​
productCategory
string
required

The category of the product

Example:

"Coffee"

​
dielineTemplateUrl
string | null
required

The dieline template for the particular product. The dieline is used as a template for creating packaging designs.

Example:

"https://acme.com/12oz-coffee-bag-dieline.png"

​
variants
number
required

The number of variants for the product

Example:

8

​
plan
string
required

The plan that is required to purchase the product

Example:

"pro"