Sync your product collections to Yotpo. A collection is a grouping of products that you can use to make your store easier to browse. For example, you might use collections to group items of a certain type such as footwear, seasonal items such as greetings cards, or items on sale.

📘

Collections endpoints are available for Reviews, SMS Marketing, and Visual UGC.

Good to know

Some e-commerce platform use a different name for product collections. Learn more about Magento product types

Collection endpoints

Collection properties

Listed below are all of the available properties for collections. To see which properties are required per endpoint, refer to the endpoint pages below.

Field

Type

Description

external_id

string

The merchant's unique ID for the collection.

name

string

The name of the product collection.

yotpo_id

long

The ID generated by Yotpo for the collection. This field is read-only.

created_at

datetime

The time the collection was first synced to Yotpo. This field is read-only.

updated_at

datetime

The time the collection was last updated in Yotpo. This field is read-only.