CustomCollections

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	A unique numeric identifier for the custom collection.
Title	String	False	The title of the custom collection.
BodyHtml	String	False	The body/description of the custom collection.
Image	String	False	A JSON aggregate with information regarding the image of custom collection.
Metafields	String	False	Attaches additional metadata to a shop's resources: key: An identifier for the metafield. (maximum: 30 characters), namespace: A container for a set of metadata. Namespaces help distinguish between metadata created by different apps. (maximum: 20 characters), value: Information to be stored as metadata, value_type: The information type being stored. Valid values: string or integer, description (optional): Additional information about the metafield .
Handle	String	False	A human-friendly unique string for the custom collection automatically generated from its title.
SortOrder	String	False	The order in which products in the custom collection appear.
TemplateSuffix	String	False	The suffix of the liquid template being used.
PublishedScope	String	False	The sales channels in which the custom collection is visible.
UpdatedAt	Datetime	True	The date and time when the custom collection was last modified.
PublishedAt	Datetime	True	The date and time when the custom collection was published to the Online Store channel.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
ProductId	String	Show custom collections that include a given product.
PublishedStatus	String	Show custom collection with a given published status: published: show only published custom collections, unpublished: show only unpublished custom collections, any: show custom collections of any published status. (default: any).