---
title: "List Products in Collection"
method: GET
path: "/v1/product-collections/{productCollectionId}/products"
tags: ["Product Collections"]
---

# List Products in Collection

`GET /v1/product-collections/{productCollectionId}/products`

## Request

- Base URL: `https://api.voucherify.io`
- URL: `https://api.voucherify.io/v1/product-collections/{productCollectionId}/products`
- Auth: one of:
  - API key in header `X-App-Id` and API key in header `X-App-Token`
  - OAuth 2
    - Implicit: `https://api.voucherify.io/v1/oauth/token`
    - Scopes: `api`, `product-collections`

Retrieves list of products from a product collection; works for both dynamic and static product collections.

## Query parameters

- `limit` integer
- `page` integer
- `order` 'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'type' | '-type' | 'code' | '-code' | 'campaign' | '-campaign' | 'category' | '-category'
- `starting_after` string, date-time

## Response `200`

Returns a dictionary of products and/or SKUs grouped in the collection with each product's/SKU's details.

- ProductCollectionsProductsListResponseBody: Response body schema for **GET** /product-collections/{productCollectionID}/products.
  - `object` string, required: The type of the object represented by JSON. This object stores information about products and SKUs.
  - `data_ref` string, required: Identifies the name of the JSON property that contains the array of products and SKUs.
  - `data` union[], required: A dictionary that contains an array of products and SKUs.
    - union
      - ProductWithoutSkus
        - `id` string, required: Unique product ID assigned by Voucherify.
        - `source_id` string, nullable, required: Unique product source ID.
        - `name` string, nullable, required: Unique user-defined product name.
        - `price` integer, nullable, 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`.
        - `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.
        - `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.
        - `image_url` string, nullable: The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
        - `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.
        - `updated_at` string, date-time, nullable: Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format.
        - `object` 'product', required: The type of the object represented by JSON. This object stores information about the product.
      - SkuWithProduct: This is an object representing a product SKU.
        - `id` string, required: A unique identifier that represents the SKU and is assigned by Voucherify.
        - `source_id` string, nullable, required: A unique SKU identifier from your inventory system.
        - `product_id` string, required: The parent product's unique ID.
        - `sku` string, nullable, required: Unique user-defined SKU name.
        - `price` integer, nullable, 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`.
        - `currency` string, nullable: SKU price currency.
        - `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.
        - `image_url` string, nullable, required: The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
        - `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.
        - `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.
        - `updated_at` string, date-time, nullable, required: Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format.
        - `object` 'sku', required: The type of the object represented by JSON. This object stores information about the `SKU`.
        - `product` ProductWithoutSkus
          - `id` string, required: Unique product ID assigned by Voucherify.
          - `source_id` string, nullable, required: Unique product source ID.
          - `name` string, nullable, required: Unique user-defined product name.
          - `price` integer, nullable, 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`.
          - `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.
          - `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.
          - `image_url` string, nullable: The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
          - `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.
          - `updated_at` string, date-time, nullable: Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format.
          - `object` 'product', required: The type of the object represented by JSON. This object stores information about the product.
  - `total` integer, required: Total number of products & SKUs in the product collection.

## Other responses

- `404`: Returns an error when requesting a product collection that has been deleted or does not exist.

---

[API](https://skmtc.dev/voucherifyio/apis/voucherify-api-async-actions.md) - [All operations](https://skmtc.dev/voucherifyio/apis/voucherify-api-async-actions/llms.txt) - [OpenAPI document](https://skmtc.dev/voucherifyio/apis/voucherify-api-async-actions/revisions/4982266e0494?raw)