Skip to content

Collections

Manage collections and the products included in each one.

Fields

idstringUnique identifier of the resource.
namestring
statusenumdraft · active
typeenumstatic · dynamic
slugstringURL-friendly identifier.
descriptionstring
templatestring
imageobject
See all 22 fields
sortOrderenummanual · titleAscending · titleDescending · priceAscending · priceDescending · createdAscending · createdDescending · bestSelling
dynamicOperatorenumand · or
validFromstring
validTostring
rulesarray<object>
pinsarray<object>
productCountinteger
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
storeIdstring
includeCollectionIdsarray<string>
excludeCollectionIdsarray<string>
includeProductIdsarray<string>
excludeProductIdsarray<string>

Operations

MethodEndpointOperation
POST/v1/catalog/collectionsCreate collection
GET/v1/catalog/collectionsList collections
GET/v1/catalog/collections/{collectionId}Get collection
PUT/v1/catalog/collections/{collectionId}Update collection
DELETE/v1/catalog/collections/{collectionId}Delete collection

Import & export

MethodEndpointOperation
POST/v1/catalog/collections/exportsExport collections
POST/v1/catalog/collections/importsImport collections

Products

MethodEndpointOperation
GET/v1/catalog/collections/{collectionId}/productsList collection products
PUT/v1/catalog/collections/{collectionId}/productsSet collection products

Last updated: