API Reference

Get Collections

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.

FieldTypeDescription
pageIntNumber of page.
perPageIntNumber of collections per page.
maxCountIntMax number of collections.
sortFieldStringFilter fields.
sortAscendingBooleanOrder by desc (false) ou by asc (true).
maxPageIntMax number of pages.
collectionsObject ArrayA list of collections.
nameStringThe name of the collection or the product.
urlStringThe collection address.
imageUrlStringThe collection image address.
hexColorHexadecimal (HEX)The collection color.
isDeletedBooleanIf the collection is deleted (true) or not (false).
productsObject ArrayThe products that the collection contains.
productIdGuidProduct Id.
codeStringProduct code.
createDateDateCreate date
lastUpdateDateLast update date
idGuidCollection Id.
clientIdStringClient id.
isActiveBooleanIf the collection is active (true) or inactive(false).
Language
Credentials
Basic
base64
:
URL