The product collections object

Data model description

The products can be grouped into collections by the creation of a products collection object. You can retrieve a product collection and a list of products in the collection. Product collections are identified by a unique ID.

Attributes

Description

Example

name
string

Defines the name of the product collection.

My Collection Name

id
string

System generated id for the product collection

pc_mU9wGzBdLlF7yKfrhxs3BIaW

type
string

Defines a static (STATIC) versus a dynamic (AUTO_UPDATE) collection.

AUTO_UPDATE or STATIC

object
string

String representing the object’s type. Objects of the same type share the same value. Value is products_collection.

products_collection

created_at
`string, ISO 8601 date format`

Date and timestamp when the product collection object is created.

2021-12-09T08:31:18.114Z

filter
object

For dynamic collection only. Defines the boundary conditions for grouping products into the collection. Required to create a dynamic collection.

"filter": {
        "junction": "and",
        "metadata.earliest_shipping_date": {
            "conditions": {
                "$before": [
                    "2021-12-31T00:00:00.000Z"
                ]
            }
        }
    }

products
array_string

For static collection only. Defines the list of products in the static collection. Required to create static collection.

"products": [
        {
            "id": "prod_0a41bcf807c5fcaaf6",
            "object": "product"
        },
        {
            "id": "prod_0a41bd277905fcaafc",
            "object": "product"
        },
        {
            "id": "prod_0a41bd5ebd01c28331",
            "object": "product"
        }
    ]