Skip to main content
GET
/
v1
/
product-collections
/
{productCollectionId}
Get Product Collection
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/product-collections/{productCollectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "pc_Dj1qSH7bho4SVh7aSDKjU174",
  "name": "Products in Poland",
  "type": "AUTO_UPDATE",
  "filter": {
    "junction": "and",
    "metadata.product_location": {
      "conditions": {
        "$in_location": [
          "loc_RcYz537sV07e1t5aG5tIH9FD"
        ]
      }
    }
  },
  "created_at": "2022-07-14T16:12:26.377Z",
  "object": "products_collection"
}

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.

Path Parameters

​
productCollectionId
string
required

A unique product collection ID.

Example:

"pc_41V4DiQQO8YGqj0J2oZD57j4"

Response

Returns a product collection object if a valid identifier was provided in the path.

Response body schema for GET v1/product-collections/{productCollectionId}. This is an object representing a product collection base.

​
id
string
required

Product collection ID.

​
name
string
required

Unique user-defined product collection name.

Example:

"All Products"

​
type
enum<string>
required

Describes whether the product collection is dynamic (products come in and leave based on set criteria) or static (manually selected products).

Available options:
STATIC,
AUTO_UPDATE
​
created_at
string<date-time>
required

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

Example:

"2021-12-09T12:51:29.898Z"

​
object
enum<string>
default:products_collection
required

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

Available options:
products_collection
​
filter
object

Defines a set of criteria and boundary conditions for an AUTO_UPDATE product collection type.

​
products
Product Collections Item Products Item · object[]

Defines a set of products for a STATIC product collection type.

⌘I