Product Collection Object

Product Collection Base

Attributes Description

id
string

Product collection ID.

name
string

Unique user-defined product collection name.

Example:

All Products

type
string

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

Available values: STATIC, AUTO_UPDATE

filter
object

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

Attributes	Description
junction	See: Junction
[propertyName]	Valid keys: `id`, `product_id`, `source_id`, `name`, `price`, `object`, `attributes`, `image_url`, `skus`, `created_at`, `updated_at` and `metadata.*` Field Conditions

products
array

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

Array of:

Product Collections Item Products Item

Attributes Description

id
string

The product ID.

Example:

prod_0a41bcf807c5fcaaf6

product_id
string

Product ID for SKUs.

object
string

Denotes the type of the object represented by the ID.

Available values: sku, product

created_at
string

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
string

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

Available values: products_collection

Junction

Logical Operator Between Filters. Filter by conditions set on the junction parameter indicating how the conditions should be accounted for in the query. An AND is an all-inclusive logical operator, meaning the AND operator displays a record if ALL the conditions separated by AND are TRUE, while an OR operator displays a record if ANY of the conditions separated by OR is TRUE.

Available values: and, or

Field Conditions

Attributes	Description
conditions	Data filters used to narrow down the data records to be returned in the result. Filters Condition

Filters Condition

Attributes	Description
$in	See: Any
$not_in	See: Any
$is	See: Any
$is_days_ago	See: Any
$is_days_in_future	See: Any
$is_not	See: Any
$has_value	See: Any
$is_unknown	See: Any
$contains	See: Any
$not_contain	See: Any
$starts_with	See: Any
$ends_with	See: Any
$more_than	See: Any
$less_than	See: Any
$more_than_ago	See: Any
$less_than_ago	See: Any
$more_than_future	See: Any
$less_than_future	See: Any
$more_than_equal	See: Any
$less_than_equal	See: Any
$after	See: Any
$before	See: Any
$count	See: Any
$count_less	See: Any
$count_more	See: Any

Any

One of:

Array any of: string, number, object
string
number
object