Skip to main content
GET
Essa rota irá retornar informações sobre os equipamentos.
🚀 API v2 (Recomendada) - Use este endpoint para novos projetos

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

pageNumber
integer
required

Determina o número da página a ser retornada.

pageLimit
integer
required

Limita a quantidade de registros retornados por página.

Query Parameters

createdBefore
string

A pesquisa retorna registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DD).

createdAfter
string

A pesquisa retorna registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).

type
enum<string>

A pesquisa retorna registros nos quais o tipo do produto é igual ao passado no parâmetro.

Available options:
module,
inverter,
stringBox,
complementaryEquipment
productCode
string

A pesquisa retorna registros nos quais o código do produto ou parte deste código é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o código 12345, pode-se passar tanto o parâmetro 12345, quanto os parâmetros 1, 2, 3, 4, 5, 12, 23, 123, 345…

name
string

A pesquisa retorna registros nos quais o nome do produto ou parte deste nome é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…

manufacturer
string

A pesquisa retorna registros nos quais o nome do fabricante do produto ou parte deste nome é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…

model
string

A pesquisa retorna registros nos quais o nome do modelo do produto ou parte deste nome é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…

basePriceGTE
number

A pesquisa retorna registros criados com preço base de valor superior ou igual ao passado no parâmetro.

basePriceLTE
number

A pesquisa retorna registros criados com preço base de valor inferior ou igual ao passado no parâmetro.

Response

OK

type
string
Example:

"module / inverter / stringBox / complementaryEquipment"

productCode
string
Example:

"codigo123"

name
string
Example:

"Nome do produto "

manufacturer
string
Example:

"Nome do fabricante"

model
string
Example:

"Modelo"

baseprice
number
Example:

1000

costPrice
number
Example:

500

nominalMaxPower
number
Example:

500

nominalOutputPower
number
Example:

10

height
number
Example:

10

width
number
Example:

10

lenght
number
Example:

10

weight
number
Example:

10

volume
number
Example:

10

Example:

true

Example:

true

isToSell
boolean
Example:

true

isToSellIntegrator
boolean
Example:

true

isToSellOptions
object
storeSellOptions
object
ecommerceSellOptions
object
inventory
object
inventoryByCenter
object[]
moduleSpecifications
object
inverterSpecifications
object
complementaryEquipmentSpecifications
object
stringBoxSpecifications
object
customData
object[]