get https://{environment}.neomode.com.br/management/catalog/collections[?page][&perPage][&includeProducts]
Retrives all the collections of products.
The fields page and perPage are required.
Retrieves a array of collections and their products if "includeProducts" is defined as true.
Field | Type | Description |
---|---|---|
page | Int | Number of page. |
perPage | Int | Number of collections per page. |
maxCount | Int | Max number of collections. |
sortField | String | Filter fields. |
sortAscending | Boolean | Order by desc (false) ou by asc (true). |
maxPage | Int | Max number of pages. |
collections | Object Array | A list of collections. |
name | String | The name of the collection or the product. |
url | String | The collection address. |
imageUrl | String | The collection image address. |
hexColor | Hexadecimal (HEX) | The collection color. |
isDeleted | Boolean | If the collection is deleted (true) or not (false). |
products | Object Array | The products that the collection contains. |
productId | Guid | Product Id. |
code | String | Product code. |
createDate | Date | Create date |
lastUpdate | Date | Last update date |
id | Guid | Collection Id. |
clientId | String | Client id. |
isActive | Boolean | If the collection is active (true) or inactive(false). |