Collection

Product Collection Model Schema

Product collections are groupings of products. They are typically pre-determined categories such as Free Shipping, On Sale, etc. used for organization and filtering.

Attributes

Attribute

Type

Example

Description

id

*required

String or Integer

"sum-sale"

Your platform's ID of the collection.

name

*required

String

"Summer Sale"

Name or title of the collection. Do not include the product name in this value.

platform_data

optional

Hash/Object

{ foo: "bar" }

This field allows you to store some extra attributes about the collection that can later be referenced and are not part of the list above.

Sample Payload

{
"id": "variant-123", // String
"name": "Variation 123", // String
"platform_data": { "any": "data" } // (Optional) Hash/Object of attributes to store about the collection, specific to the integration platform (can be used in future filters)
}

How Collections Are Used

Fera will utilize collection information to filter what content should be displayed on your pages. You can specify the use of collection filters when creating your skills, to hide / show Fera content only on matching product pages.