Create Product Collection

POST 
/products/collections

Create a new Product Collection for a specific location

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id

altTypestringrequired
The type of alt. For now it is only LOCATION
Available optionslocation
collectionIdstring

Unique Identifier of the Product Collection, Mongo Id

namestringrequired

Name of the Product Collection

slugstringrequired

Slug of the Product Collection which helps in navigation

imagestring

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

seoobject

The metadata information which will be displayed in SEO previews

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "LOCATION",
  "collectionId": "66057f9d28536eae584ec047",
  "name": "Best Sellers",
  "slug": "best-sellers",
  "image": "http://example.com/watermark.png",
  "seo": {
    "title": "Best Sellers",
    "description": "Collections where all the best products are available"
  }
}

application/json

Successful response

application/json

Schema

Schema

dataobjectrequired

created Collection

Example (auto)

{
  "data": {
    "_id": "655b33a82209e60b6adb87a5",
    "altId": "Z4Bxl8J4SaPEPLq9IQ8g",
    "name": "Best Sellers",
    "slug": "best-sellers",
    "image": "http://example.com/watermark.png",
    "seo": {
      "title": "Best Sellers",
      "description": "Collections where all the best products are available"
    },
    "createdAt": "2024-02-22T09:27:19.728Z"
  }
}