Get Products

get https://{environment}.neomode.com.br/management/catalog/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:

Campo	Tipo	Descrição
page	Int	Number of the page searched.
perPage	Int	Number of items per page.
maxCount	Int	Total of items searched.
maxPage	Int	Total number of pages.
products	Object Array	Product object array.
id	Guid	Product's Id.
name	String	Product's name.
code	String	Product's code.
hasStock	Boolean	If the product has any sku with stock.
hasPrice	Boolean	If the product has prices defined.
isActive	Boolean	If the product is active or not.
isAvailable	Boolean	If the product is available for sale.

Path Params

environment

string

required

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

Query Params

page

int32

required

Defaults to 1

Number of the search page

perPage

int32

required

Defaults to 20

Number of items per page

sortAscending

boolean

Defaults to false

Filter items by Asc (true) or Desc (false)

sortField

string

Filter field

query

string

Filter products by Name, Code, AuxCode or ReferenceCode

isActive

boolean

Defaults to false

Search only active products

hasStock

boolean

Defaults to false

Search only products thas has stocks available.

hasPrice

boolean

Defaults to false

Search only products with defined prices.

isAvailable

boolean

Defaults to false

Search only products that are available for sale

hasImage

boolean

Defaults to false

If set as true, search only porducts with images defined. If false, search only products without images defined

lastUpdate

date

Filter items by their last update.

Responses

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://environment.neomode.com.br/management/catalog/products?page=1&perPage=20&sortAscending=false&isActive=false&hasStock=false&hasPrice=false&isAvailable=false&hasImage=false' \
3
     --header 'accept: application/json'

Choose an example:

application/json