API Reference

Get Products

Retrieves all the products of a seller.

Use the "QueryParams" to filter the products in your search. It is mandatory to inform the parameter "page" and "perPage in the query.

Fields retrieved:

CampoTipoDescrição
pageIntNumber of the page searched.
perPageIntNumber of items per page.
maxCountIntTotal of items searched.
maxPageIntTotal number of pages.
productsObject ArrayProduct object array.
idGuidProduct's Id.
nameStringProduct's name.
codeStringProduct's code.
hasStockBooleanIf the product has any sku with stock.
hasPriceBooleanIf the product has prices defined.
isActiveBooleanIf the product is active or not.
isAvailableBooleanIf the product is available for sale.
Language
Credentials
Basic
base64
:
URL