API Reference

Get Product Categories

Retrieves an array of product categories.
Pagination params (page and perPage) are required.

Fields retrieved:

FieldTypeDescription
pageIntPage number.
perPageIntNumber of product categories per page.
maxCountIntMax number of product categories found.
sortFieldStringFilter fields.
sortAscendingBooleanOrder by asc (true) or desc (false).
maxPageIntMax number of pages on catalog.
productCategoriesObject ArrayAn array with the product categories found.
categoryIdGuidCategory ID.
categoryNameStringCategory name.
categoryCodeStringCategory code.
productIdGuidProduct ID.
productNameStringProduct name.
productCodeStringProduct code.
lastUpdateDateProduct Category last update.
Path Params
string
required

Use "api" for production environment or "hlg-api" for homolog

Query Params
int32
required

Page number

int32
required

Number of items per page

Responses

Language
Credentials
:
URL
Choose an example:
application/json