Products

Get Product By ID

Get a product by ID in your Roastify Merchant account

get/v1/products/{id}

Request

  • Base URL: https://api.roastify.app
  • URL: https://api.roastify.app/v1/products/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

The ID of the product

Example:clyd67824rn3f78g0f8j9

Response

Returns a product by ID in your Roastify Merchant account

idstring required

The ID of the product

createdAtstring required

The date and time the product was created in ISO format

titlestring required

The title of the product

descriptionstring required

The description of the product

imageUrlstring required

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

productType'SampleBox' | 'IndSample2oz' | 'CoffeeBag12oz' | 'CoffeeBox12oz' | 'CoffeeBag5lb' | 'Pods' | 'InstantCoffee' | 'Tubes'

The Catalog Product Type

Example response

{
  "id": "clyd67824rn3f78g0f8j9",
  "createdAt": "2024-02-19T17:09:28.925Z",
  "title": "12oz Coffee Box",
  "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"
    }
  ]
}

Changes

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