Get All Collections

Retrieves a list of all collections matching a filter.

Response body has the following properties:

AttributeTypeDescription
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
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

Response body example:

{
    "paging": {
        "page": 1,
        "perPage": 20,
        "total": 1033,
        "pages": 52
    },
    "items": [
        {
            "id": 2591,
            "name": "Black Friday 2020",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-02T11:56:00",
            "dateTo": "2069-03-02T11:56:00",
            "totalSku": 615,
            "totalProducts": 615,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2593,
            "name": "Coleção Leve 3 pague 2",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-02T12:10:00",
            "dateTo": "2069-03-02T12:10:00",
            "totalSku": 957,
            "totalProducts": 957,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2728,
            "name": "Coleção Leve 4 pague 3",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-04T14:06:00",
            "dateTo": "2069-03-04T14:06:00",
            "totalSku": 913,
            "totalProducts": 913,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "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": 2764,
            "name": "Coleção tudo com 60% de desconto",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-04T20:10:00",
            "dateTo": "2069-03-04T20:10:00",
            "totalSku": 57491,
            "totalProducts": 57491,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2772,
            "name": "colecao thay",
            "searchable": true,
            "highlight": false,
            "dateFrom": "2020-03-04T20:25:00",
            "dateTo": "2069-03-04T20:25:00",
            "totalSku": 9,
            "totalProducts": 9,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2773,
            "name": "nova coleção",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-04T20:33:00",
            "dateTo": "2069-03-04T20:33:00",
            "totalSku": 1,
            "totalProducts": 1,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2774,
            "name": "1583354501308",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2023-01-01T16:36:00",
            "dateTo": "2069-03-04T20:39:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2776,
            "name": "test collection",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T13:10:00",
            "dateTo": "2069-03-05T13:10:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2781,
            "name": "Coleção Outlet",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T13:25:00",
            "dateTo": "2069-03-05T13:25:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2793,
            "name": "test collection",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T13:47:00",
            "dateTo": "2069-03-05T13:47:00",
            "totalSku": 8,
            "totalProducts": 8,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2804,
            "name": "test collection",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T14:10:00",
            "dateTo": "2069-03-05T14:10:00",
            "totalSku": 963,
            "totalProducts": 963,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2807,
            "name": "1583417677593",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T14:12:00",
            "dateTo": "2069-03-05T14:12:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2808,
            "name": "test collection",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T14:12:00",
            "dateTo": "2069-03-05T14:12:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2809,
            "name": "1583417711900",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T14:12:00",
            "dateTo": "2069-03-05T14:12:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2810,
            "name": "1583417737284",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T14:13:00",
            "dateTo": "2069-03-05T14:13:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2847,
            "name": "nao mexe",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T18:27:00",
            "dateTo": "2069-03-05T18:27:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2866,
            "name": "1583434866018",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2020-03-05T19:00:00",
            "dateTo": "2069-03-05T19:00:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        },
        {
            "id": 2867,
            "name": "1583434876921",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2023-01-01T16:36:00",
            "dateTo": "2072-01-01T16:36:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
        }
    ]
}
Language
Authentication
URL
Click Try It! to start a request and see the response here!