Create Collection

Creates a new collection.

Request body has the following properties:

AttributeTypeDescription
namestringCollection's Name
searchablebooleanOption making the collection searchable in the store
highlightbooleanOption if you want the collection to highlight specific products using a tag
dateFromstringCollection start date and time. If a future date and time are set, the collection will have a scheduled status
dateTostringCollection end date and time
descriptionstringCollection's description for internal use, with the collection's details. It will not be used for search engines

Request body example:

{
    "name": "My Collection",
    "searchable": true,
    "highlight": true,
    "dateFrom": "2020-12-11 16:00:00",
    "dateTo": "2020-12-12 16:00:00",
    "description": "Just a simple collection."
}

Response body has the following properties:

AttributeTypeDescription
idintegerCollection's ID
namestringCollection's Name
searchablebooleanOption making the collection searchable in the store
highlightbooleanOption if you want the collection to highlight specific products using a tag
dateFromstringCollection start date and time. If a future date and time are set, the collection will have a scheduled status
dateTostringCollection end date and time
descriptionstringCollection's description for internal use, with the collection's details. It will not be used for search engines
totalProductsintegerTotal of Products on the Collection
typestringType of the Collection. It can be Manual, Automatic and Hybrid

Response body example:

{
    "Id": 10854,
    "Name": "My Collection",
    "Description": "Just a simple collection.",
    "Searchable": true,
    "Highlight": true,
    "DateFrom": "2020-12-11T16:00:00",
    "DateTo": "2020-12-12T16:00:00",
    "TotalProducts": 0,
    "Type": "Manual"
}
Language
Authentication
URL
Click Try It! to start a request and see the response here!