collectionByHandle
query
An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.
Retrieves a Collection using its handle.
Arguments
The collection's handle
Return
The banner associated with the collection.
The collection's description, which includes any tags of HTML and formatting. The content of description is typically shown to customers according to the theme.
A unique string used to identify the collection. If the handle is not specified during the collection creation process, it will be automatically generated based on the collection's title.
Whether the specified product is bound to the current collection.
Globally unique collection ID.
The cover image for collection
The list of products in the current collection.
The number of products in the collection.
The resources that have been published or are ready to be published. Currently, querying the collection ResoursePublicationV2 is not supported.
The rules that specify whether a product is included in a smart collection.
Seo information of the collection.
By default, the display order of products within the category in the SHOPLINE backend and sales channels like online stores.
The theme template used for viewing collection in the store.
The collection's name, which is showed in the Shopline backend and typically shown in sales channels, for example, online stores.
The collection's modification time in ISO 8601 format.
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?