Products

Get All User Products

Get all products in your Roastify Merchant account

get/v1/products

Request

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

Query parameters

cursorstring

The cursor to start from. This is the productId of the last product in the previous page. This can also be found in the endCursor property of the previous page's response.

Example:clyd67824rn3f78g0f8j9

pageSizestring

The number of results to return. Defaults to 20 and maximum is 100

Example:10

Response

Returns all products in your Roastify Merchant account (paginated)

Example response

{
  "products": [
    {
      "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.