Catalog

Get All Catalog Products

Get all available products in the Roastify Catalog

get/v1/catalog/products

Request

Base URL: https://api.roastify.app
URL: https://api.roastify.app/v1/catalog/products
Auth: API key in header x-api-key

Response

Get all available products in the Roastify Catalog

idstring required

The id of the product

titlestring required

The title of the product

descriptionstring required

The description of the product

imageUrlstring required

The image url of the product (HTTPS only with valid image extension)

productTypestring required

The type of the product

productCategorystring required

The category of the product

dielineTemplateUrlstring nullable required

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

variantsnumber required

The number of variants for the product

planstring required

The plan that is required to purchase the product

Example response

[
  {
    "id": "clyd67824rn3f78g0f8j9",
    "title": "12oz Coffee Box",
    "imageUrl": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg",
    "productType": "12ozCoffeeBox",
    "productCategory": "Coffee",
    "dielineTemplateUrl": "https://acme.com/12oz-coffee-bag-dieline.png",
    "variants": 8,
    "plan": "pro"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.