Collection
Manage curated product collections displayed on the storefront.
A collection is a grouping of products that the merchant displays together in the storefront, such as a seasonal lineup or a curated set. Each collection carries its own title, description, SEO attributes, associated products, and merchandise sorting rules.
Provides endpoints to create, list, retrieve, update, and delete collections, and to count collections matching given criteria.
List collections
Retrieves a list of collections based on various filter criteria, such as product_id, title, or update timestamps.
Create collection
Allows users to create a new collection in the store, including details like the title, description, associated products, SEO attributes, and merchandise sorting rules.
Get collection count
Retrieve the total number of collections that match specific criteria.
Get collection
Retrieves detailed information about a specific collection by providing its unique identifier.
Update collection
Allows users to update details of an existing collection by providing the collection ID and the desired updates in the request body.
Delete collection
Allows users to delete a specific collection by providing its unique ID in the path parameter.
Update smart collection rules
Allows users to update smart collection rules by providing the collection ID and the desired updates in the request body.
Asynchronously create a smart collection
Initiates an asynchronous creation of a smart collection. Only smart collections are supported by this endpoint.
Asynchronously update smart collection rules
Initiates an asynchronous update of a smart collection's match rules. Returns an async task ID immediately;
Get collection async task
Retrieves the status and result of an asynchronous collection task initiated by AsyncCreateCollection or AsyncUpdateSmartCollectionRule.