Skip to main content
GET
/
v1
/
products
/
{id}
Get Product By ID
curl --request GET \
  --url https://api.roastify.app/v1/products/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "clyd67824rn3f78g0f8j9",
  "createdAt": "2024-02-19T17:09:28.925Z",
  "title": "12oz Coffee Box",
  "description": "<string>",
  "imageUrl": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg",
  "productType": "CoffeeBox12oz",
  "images": [
    {
      "url": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg"
    }
  ],
  "variants": [
    {
      "id": "clyd67824rn3f78g0f8j9",
      "title": "Whole Bean",
      "size": "12oz",
      "retailPrice": 1200,
      "sku": "COF-GND-12O-COL-BOX",
      "inStock": true,
      "stockQty": 999,
      "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 product

Example:

"clyd67824rn3f78g0f8j9"

Response

Returns a product by ID in your Roastify Merchant account

​
id
string
required

The ID of the product

Example:

"clyd67824rn3f78g0f8j9"

​
createdAt
string
required

The date and time the product was created in ISO format

Example:

"2024-02-19T17:09:28.925Z"

​
title
string
required

The title of the product

Example:

"12oz Coffee Box"

​
description
string
required

The description of the product

​
imageUrl
string
required

The artwork URL of the product

Example:

"https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg"

​
productType
enum<string>

The Catalog Product Type

Available options:
SampleBox,
IndSample2oz,
CoffeeBag12oz,
CoffeeBox12oz,
CoffeeBag5lb,
Pods,
InstantCoffee,
Tubes
Example:

"CoffeeBox12oz"

​
images
object[]
​
variants
object[]
⌘I