Skip to main content
CollectionsVersion: v3

Create Product Collection

POST/products/collections

Create a new Product Collection for a specific location

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:products/collection.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Body

altIdstringrequired

Location Id

Example:6578278e879ad2646715ba9c
altTypestringrequired

The type of alt. For now it is only LOCATION

Available optionslocation
Example:LOCATION
collectionIdstring

Unique Identifier of the Product Collection, Mongo Id

Example:66057f9d28536eae584ec047
namestringrequired

Name of the Product Collection

Example:Best Sellers
slugstringrequired

Slug of the Product Collection which helps in navigation

Example:best-sellers
imagestring

The URL of the image that is going to be displayed as the collection Thumbnail

Example:http://example.com/watermark.png
seoobject

The metadata information which will be displayed in SEO previews

Response

Successful response

dataobjectrequired

created Collection