get https://{accountName}.{environment}.com.br/api/catalog_system/pvt/collection/search/
Retrieves a list of collections matching a filter.
Response body has the following properties:
Attribute | Type | Description |
---|---|---|
items | array of objects | Object with general information about the Collections |
id | integer | Collection's ID |
name | string | Collection's Name |
searchable | boolean | Option making the collection searchable in the store |
highlight | boolean | Option if you want the collection to highlight specific products using a tag |
dateFrom | string | Collection start date and time. If a future date and time are set, the collection will have a scheduled status |
dateTo | string | Collection end date and time |
totalSku | integer | Total of SKUs on the Collection |
totalProducts | integer | Total of Products on the Collection |
type | string | Type of the Collection. It can be Manual , Automatic and Hybrid |
lastModifiedBy | string | Last user that modified the Collection |
paging | object | General information about the paging of the Collection dashboard |
page | integer | Page number of the Collection dashboard |
perPage | integer | Quantity of Collections per page |
total | integer | Total of Collections |
pages | integer | Total 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
}
}