Skip to main content
POST
/
v1
/
product-collections
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/product-collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "type": "STATIC",
  "name": "Static collection example",
  "products": [
    {
      "id": "prod_0a41dd45dc85fcab40",
      "object": "product"
    }
  ]
}'
{
  "id": "<string>",
  "name": "All Products",
  "type": "STATIC",
  "filter": {
    "junction": "and"
  },
  "products": [
    {
      "id": "prod_0a41bcf807c5fcaaf6",
      "product_id": "<string>",
      "object": "sku"
    }
  ],
  "created_at": "2021-12-09T12:51:29.898Z",
  "object": "products_collection"
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

Body

application/json
  • Product Collections Create Static Request Body
  • Product Collections Create Dynamic (Auto Update) Request Body
​
type
enum<string>
default:STATIC
required
Available options:
STATIC
​
name
string
required
​
products
Product Collections Create Dynamic Request Body Products Item · object[]

Response

200 - application/json
​
id
string
required
​
name
string
required
Example:
​
type
enum<string>
required
Available options:
STATIC,
AUTO_UPDATE
​
created_at
string<date-time>
required
Example:
​
object
enum<string>
default:products_collection
required
Available options:
products_collection
​
filter
object
​
products
Product Collections Item Products Item · object[]