GuidesChangelogHelp CenterRoadmap
API Reference

Product Collection Object

Product Collection Base

AttributesDescription
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.

AttributesDescription
junctionSee: 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

AttributesDescription
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

AttributesDescription
conditions

Data filters used to narrow down the data records to be returned in the result.

Filters Condition

Filters Condition

AttributesDescription
$inSee: Any
$not_inSee: Any
$isSee: Any
$is_days_agoSee: Any
$is_days_in_futureSee: Any
$is_notSee: Any
$has_valueSee: Any
$is_unknownSee: Any
$containsSee: Any
$not_containSee: Any
$starts_withSee: Any
$ends_withSee: Any
$more_thanSee: Any
$less_thanSee: Any
$more_than_agoSee: Any
$less_than_agoSee: Any
$more_than_futureSee: Any
$less_than_futureSee: Any
$more_than_equalSee: Any
$less_than_equalSee: Any
$afterSee: Any
$beforeSee: Any
$countSee: Any
$count_lessSee: Any
$count_moreSee: Any

Any

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