List Products

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "object": "list",
  "data_ref": "products",
  "products": [
    {
      "id": "prod_f1r5Tpr0DuC7",
      "source_id": "test_prod_id_1",
      "name": "Apple iPhone 8",
      "price": null,
      "attributes": [
        "color",
        "memory"
      ],
      "metadata": {
        "test": true,
        "vendor": "Cortland"
      },
      "image_url": null,
      "created_at": "2021-12-03T06:33:46.101Z",
      "updated_at": null,
      "object": "product",
      "skus": {
        "data": [
          {
            "id": "sku_0a417bd1d9952f9d6f",
            "source_id": "test_iphone_8_silver_256gb",
            "product_id": "prod_f1r5Tpr0DuC7",
            "sku": "iPhone 8 Silver 256GB",
            "price": null,
            "currency": null,
            "attributes": {
              "color": "silver",
              "memory": "256"
            },
            "image_url": null,
            "metadata": {},
            "created_at": "2021-12-03T06:33:46.599097+00:00",
            "updated_at": null,
            "object": "sku"
          },
          {
            "id": "sku_0a417bd1d9952f9d6e",
            "source_id": "test_iphone_8_silver_64gb",
            "product_id": "prod_f1r5Tpr0DuC7",
            "sku": "iPhone 8 Silver 64GB",
            "price": null,
            "currency": null,
            "attributes": {
              "color": "silver",
              "memory": "64"
            },
            "image_url": null,
            "metadata": {},
            "created_at": "2021-12-03T06:33:46.598595+00:00",
            "updated_at": null,
            "object": "sku"
          }
        ],
        "total": 2
      }
    },
    {
      "id": "prod_0ac67e1bb8072eec48",
      "source_id": "test_volleyball",
      "name": "VolleyBall",
      "price": 1100,
      "attributes": [],
      "metadata": {
        "color": [
          "white"
        ],
        "label": true,
        "origin": "PL"
      },
      "image_url": null,
      "created_at": "2022-03-16T14:01:45.459Z",
      "updated_at": "2022-04-26T12:51:35.500Z",
      "object": "product",
      "skus": {
        "data": [
          {
            "id": "sku_0ac768973f5c4ea0d0",
            "source_id": "test_volleyball_pl",
            "product_id": "prod_0ac67e1bb8072eec48",
            "sku": "PL",
            "price": 500,
            "currency": "USD",
            "attributes": {},
            "image_url": null,
            "metadata": {
              "color": [
                "red"
              ]
            },
            "created_at": "2022-03-17T07:06:13.629918+00:00",
            "updated_at": null,
            "object": "sku"
          },
          {
            "id": "sku_0ac7689713072e1df6",
            "source_id": "test_volleyball_us",
            "product_id": "prod_0ac67e1bb8072eec48",
            "sku": "US",
            "price": 1500,
            "currency": "USD",
            "attributes": {},
            "image_url": null,
            "metadata": {
              "color": [
                "yellow"
              ]
            },
            "created_at": "2022-03-17T07:06:13.452532+00:00",
            "updated_at": null,
            "object": "sku"
          }
        ],
        "total": 2
      }
    }
  ],
  "total": 2
}

GET

products

List Products

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "object": "list",
  "data_ref": "products",
  "products": [
    {
      "id": "prod_f1r5Tpr0DuC7",
      "source_id": "test_prod_id_1",
      "name": "Apple iPhone 8",
      "price": null,
      "attributes": [
        "color",
        "memory"
      ],
      "metadata": {
        "test": true,
        "vendor": "Cortland"
      },
      "image_url": null,
      "created_at": "2021-12-03T06:33:46.101Z",
      "updated_at": null,
      "object": "product",
      "skus": {
        "data": [
          {
            "id": "sku_0a417bd1d9952f9d6f",
            "source_id": "test_iphone_8_silver_256gb",
            "product_id": "prod_f1r5Tpr0DuC7",
            "sku": "iPhone 8 Silver 256GB",
            "price": null,
            "currency": null,
            "attributes": {
              "color": "silver",
              "memory": "256"
            },
            "image_url": null,
            "metadata": {},
            "created_at": "2021-12-03T06:33:46.599097+00:00",
            "updated_at": null,
            "object": "sku"
          },
          {
            "id": "sku_0a417bd1d9952f9d6e",
            "source_id": "test_iphone_8_silver_64gb",
            "product_id": "prod_f1r5Tpr0DuC7",
            "sku": "iPhone 8 Silver 64GB",
            "price": null,
            "currency": null,
            "attributes": {
              "color": "silver",
              "memory": "64"
            },
            "image_url": null,
            "metadata": {},
            "created_at": "2021-12-03T06:33:46.598595+00:00",
            "updated_at": null,
            "object": "sku"
          }
        ],
        "total": 2
      }
    },
    {
      "id": "prod_0ac67e1bb8072eec48",
      "source_id": "test_volleyball",
      "name": "VolleyBall",
      "price": 1100,
      "attributes": [],
      "metadata": {
        "color": [
          "white"
        ],
        "label": true,
        "origin": "PL"
      },
      "image_url": null,
      "created_at": "2022-03-16T14:01:45.459Z",
      "updated_at": "2022-04-26T12:51:35.500Z",
      "object": "product",
      "skus": {
        "data": [
          {
            "id": "sku_0ac768973f5c4ea0d0",
            "source_id": "test_volleyball_pl",
            "product_id": "prod_0ac67e1bb8072eec48",
            "sku": "PL",
            "price": 500,
            "currency": "USD",
            "attributes": {},
            "image_url": null,
            "metadata": {
              "color": [
                "red"
              ]
            },
            "created_at": "2022-03-17T07:06:13.629918+00:00",
            "updated_at": null,
            "object": "sku"
          },
          {
            "id": "sku_0ac7689713072e1df6",
            "source_id": "test_volleyball_us",
            "product_id": "prod_0ac67e1bb8072eec48",
            "sku": "US",
            "price": 1500,
            "currency": "USD",
            "attributes": {},
            "image_url": null,
            "metadata": {
              "color": [
                "yellow"
              ]
            },
            "created_at": "2022-03-17T07:06:13.452532+00:00",
            "updated_at": null,
            "object": "sku"
          }
        ],
        "total": 2
      }
    }
  ],
  "total": 2
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit

integer

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

Required range: 1 <= x <= 100

page

integer

Which page of results to return. The lowest value is 1.

Required range: 1 <= x <= 100

order

enum<string>

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Available options:

created_at,

-created_at,

updated_at,

-updated_at,

type,

-type,

code,

-code,

campaign,

-campaign,

category,

-category

start_date

string<date-time>

Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

Example:

"2023-12-22T10:13:06.487Z"

end_date

string<date-time>

Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

Example:

"2023-12-22T10:13:06.487Z"

Response

200 - application/json

Returns a dictionary with product objects. The products are returned sorted by creation date by default, with the most recent products appearing last, unless you specify another sequence using the order query parameter.

Response body schema for GET v1/products.

object

string

default:list

required

The type of the object represented by JSON. This object stores information about products in a dictionary.

data_ref

string

default:products

required

Identifies the name of the attribute that contains the array of product objects.

products

Product · object[]

required

Contains array of product objects.

Show child attributes

products.id

string

required

Unique product ID assigned by Voucherify.

Example:

"prod_0b1da8105693710357"

products.source_id

string | null

required

Unique product source ID.

Example:

"productSourceID16"

products.name

string | null

required

Unique user-defined product name.

Example:

"T-shirt"

products.price

integer | null

required

Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as $100.00 being expressed as 10000.

products.attributes

string[]

required

A list of product attributes whose values you can customize for given SKUs: ["color","size","ranking"]. Each child SKU can have a unique value for a given attribute.

products.metadata

object

required

The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.

products.object

enum<string>

default:product

required

The type of the object represented by JSON. This object stores information about the product.

Available options:

product

products.image_url

string | null

The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.

Example:

"https://images.com/original.jpg"

products.created_at

string<date-time>

Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format.

Example:

"2022-05-23T06:52:55.008Z"

products.updated_at

string<date-time> | null

Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format.

Example:

"2022-05-23T09:24:07.405Z"

products.skus

Skus List For Product · object

Contains information about child SKUs.

Show child attributes

products.skus.object

string

default:list

required

The type of the object represented by JSON. This object stores information about SKUs.

products.skus.data_ref

string

default:data

required

Identifies the name of the JSON property that contains the array of SKUs.

products.skus.data

SKU Object · object[]

required

A dictionary that contains an array of SKUs.

Show child attributes

products.skus.data.id

string

required

A unique identifier that represents the SKU and is assigned by Voucherify.

Example:

"sku_0b1621b319d248b79f"

products.skus.data.source_id

string | null

required

A unique SKU identifier from your inventory system.

Example:

"sku_source_id_4"

products.skus.data.product_id

string

required

The parent product's unique ID.

Example:

"prod_0b15f6b9f650c16990"

products.skus.data.sku

string | null

required

Unique user-defined SKU name.

Example:

"Large Pink Shirt"

products.skus.data.price

integer | null

required

Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as $100.00 being expressed as 10000.

products.skus.data.attributes

object

required

The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family.

products.skus.data.image_url

string | null

required

The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.

products.skus.data.metadata

object

required

The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.

products.skus.data.created_at

string<date-time>

required

Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format.

Example:

"2022-05-17T10:36:30.187Z"

products.skus.data.updated_at

string<date-time> | null

required

Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format.

Example:

"2022-05-17T10:55:09.137Z"

products.skus.data.object

enum<string>

default:sku

required

The type of the object represented by JSON. This object stores information about the SKU.

Available options:

sku

products.skus.data.currency

string | null

SKU price currency.

Example:

"USD"

products.skus.total

integer

required

Total number of SKUs in the product.

total

integer

required

Total number of product objects.

Last modified on December 3, 2025

SKU Object Get Product

⌘I

Introduction

Endpoints

Events

List Products

Authorizations

Query Parameters

Response