Get Collections by search terms

Retrieves a list of collections matching a filter.

Response body has the following properties:

AttributeTypeDescription
itemsarray of objectsObject with general information about the Collections
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
totalSkuintegerTotal of SKUs on the Collection
totalProductsintegerTotal of Products on the Collection
typestringType of the Collection. It can be Manual, Automatic and Hybrid
lastModifiedBystringLast user that modified the Collection
pagingobjectGeneral information about the paging of the Collection dashboard
pageintegerPage number of the Collection dashboard
perPageintegerQuantity of Collections per page
totalintegerTotal of Collections
pagesintegerTotal number of pages

Response body example:

{
    "items": [
        {
            "id": 2758,
            "name": "Coleção Verão",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-04T19:17:00",
            "dateTo": "2069-03-04T19:17:00",
            "totalSku": 12,
            "totalProducts": 12,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 6206,
            "name": "Coleção Primavera Verão",
            "searchable": false,
            "highlight": true,
            "dateFrom": "2020-06-06T14:40:00",
            "dateTo": "2069-06-14T14:40:00",
            "totalSku": 12,
            "totalProducts": 12,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 7140,
            "name": "Coleção Verão",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-06-18T21:01:00",
            "dateTo": "2069-06-18T21:01:00",
            "totalSku": 4,
            "totalProducts": 4,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 7149,
            "name": "Coleção Primavera Verão",
            "searchable": true,
            "highlight": true,
            "dateFrom": "2020-06-18T21:33:00",
            "dateTo": "2069-06-18T21:33:00",
            "totalSku": 22,
            "totalProducts": 22,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 8052,
            "name": "Coleção Vera Verão",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-06-29T19:40:00",
            "dateTo": "2069-06-29T19:40:00",
            "totalSku": 10,
            "totalProducts": 10,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 8054,
            "name": "Coleção de Verão - 2021",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-06-29T19:51:00",
            "dateTo": "2069-06-29T19:51:00",
            "totalSku": 7,
            "totalProducts": 7,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 10118,
            "name": "Coleção Verão",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-09-30T19:48:00",
            "dateTo": "2069-09-30T19:48:00",
            "totalSku": 12,
            "totalProducts": 12,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 10765,
            "name": "Coleção Verão?",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-11-11T16:41:00",
            "dateTo": "2069-11-11T16:41:00",
            "totalSku": 5,
            "totalProducts": 5,
            "type": "Manual",
            "lastModifiedBy": null
        }
    ],
    "paging": {
        "page": 1,
        "perPage": 20,
        "total": 8,
        "pages": 1
    }
}
Language
Authentication
URL
Click Try It! to start a request and see the response here!