GET
/
v1
/
catalog
/
products
/
{id}
Get Product by ID
curl --request GET \
  --url https://api.roastify.app/v1/catalog/products/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "clyd67824rn3f78g0f8j9",
  "title": "12oz Coffee Box",
  "description": "<string>",
  "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"
}

Authorizations

​
x-api-key
string
header
required

The API key to authenticate requests provided by Roastify. A Base or Pro plan is required to use the API.

Path Parameters

​
id
string
required

The Id of the resource

Minimum length: 1
Example:

"clyd67824rn3f78g0f8j9"

Response

Get a product by Id 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://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg"

​
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"