Fields
uid
StringThe unique identifier for the collection.
type
StringType of collections e.g query, items.
name
StringThe name of the collection.
published
BooleanWhether collection is published or not.
description
StringDetailed description of the collection,.
is_active
BooleanIndicates whether the collection is active.
slug
StringThe URL-friendly identifier for the collection.
allow_facets
BooleanIndicates if facets are allowed for filtering within the collection.
allow_sort
BooleanIndicates if sorting is allowed for this collection.
sortOn
StringThe attribute by which the collection items are sorted.
priority
IntPriority level of the collection for sorting or display purposes.
schedule
ScheduleSchedule details for the collection, including timing and duration information.
seo
SEOSEO metadata for the collection.
badge
BadgeBadge information associated with the collection.
visible_facets_keys
[String]Keys of the facets visible for filtering within the collection.
_custom_json
JSONCustom JSON object containing additional properties specific to the collection.
action
CollectionActionTags associated with the collection.
tags
[String]Logo image associated with the collection.
logo
CollectionLogoThe URL for the logo of the product grouping.
banners
ImageUrlsBanner URLs associated with the collection.
query
[CollectionQuery]A list of queries used to filter the collection.
products
ProductConnectionList of product details included in the response.
Was this section helpful?