Retorna informações sobre os equipamentos

Essa rota irá retornar informações sobre os equipamentos.

curl --request GET \
  --url https://backend-pied-prod.piedadmin.com.br/api/v2/equipments/{pageNumber}/{pageLimit} \
  --header 'Authorization: Bearer <token>'

{
  "type": "module / inverter / stringBox / complementaryEquipment",
  "productCode": "codigo123",
  "name": "Nome do produto ",
  "manufacturer": "Nome do fabricante",
  "model": "Modelo",
  "baseprice": 1000,
  "costPrice": 500,
  "nominalMaxPower": 500,
  "nominalOutputPower": 10,
  "height": 10,
  "width": 10,
  "lenght": 10,
  "weight": 10,
  "volume": 10,
  "featured": true,
  "featuredEcommerce": true,
  "isToSell": true,
  "isToSellIntegrator": true,
  "isToSellOptions": {
    "separatedSales": true,
    "closedKitSales": true,
    "mountKitSales": true
  },
  "storeSellOptions": {
    "separatedSales": true,
    "closedKitSales": true
  },
  "ecommerceSellOptions": {
    "separatedSales": true,
    "closedKitSales": true
  },
  "inventory": {
    "current": 100,
    "reserved": 50,
    "minimum": 0
  },
  "inventoryByCenter": [
    {
      "center": "CD001",
      "current": 100,
      "reserved": 50,
      "minimum": 0
    }
  ],
  "moduleSpecifications": {
    "ratedMaximumPower": 500,
    "efficiency": 10,
    "openCircuitVoltage": 40.5,
    "shortCircuitCurrent": 9.5,
    "maximumPowerVoltage": 33.5,
    "maximumPowerCurrent": 8.5,
    "cellType": "mono"
  },
  "inverterSpecifications": {
    "inverterType": "Tipo de inversor",
    "connectionType": "Tipo de ligação",
    "maximumInputPower": 10,
    "maximumInputPowerPerString": 500,
    "startVoltage": 100,
    "minimumMPPTVoltage": 150,
    "maximumMPPTVoltage": 1000,
    "mpptAmount": 2,
    "ratedOutputPower": 10,
    "ratedOutputVoltage": 400,
    "maximumOutputCurrent": 50,
    "maximumInputCurrentPerMPPT": [
      20
    ],
    "maximumInputCurrent": [
      40
    ],
    "stringsPerMPPT": [
      20
    ],
    "maximumCurrentDCConnector": [
      20
    ],
    "maximumCurrent": [
      20
    ],
    "solarEdgeSpecifications": {
      "compatibleInverters": [
        1
      ],
      "minimumStringLength": [
        1
      ],
      "maximumStringLength": [
        1
      ],
      "maximumContinuousPowerPerString": [
        5000
      ],
      "maximumConnectedPowerPer2String": [
        5000
      ],
      "maximumConnectedPowerPerString": [
        5000
      ],
      "maximumConnectedPowerPer3String": [
        5000
      ],
      "maximumConnectedPowerPer4String": [
        5000
      ]
    }
  },
  "complementaryEquipmentSpecifications": {
    "category": {
      "id": "200000000",
      "name": "Categoria",
      "type": "Tipo da categoria"
    }
  },
  "stringBoxSpecifications": {
    "inputAmount": [
      1
    ],
    "outputAmount": [
      1
    ],
    "maximumStringVoltage": 1000,
    "maximumStringCurrent": 20
  },
  "customData": [
    {
      "key": "<string>",
      "value": "0000",
      "type": "text"
    }
  ]
}

GET

equipments

{pageNumber}

{pageLimit}

Essa rota irá retornar informações sobre os equipamentos.

curl --request GET \
  --url https://backend-pied-prod.piedadmin.com.br/api/v2/equipments/{pageNumber}/{pageLimit} \
  --header 'Authorization: Bearer <token>'

{
  "type": "module / inverter / stringBox / complementaryEquipment",
  "productCode": "codigo123",
  "name": "Nome do produto ",
  "manufacturer": "Nome do fabricante",
  "model": "Modelo",
  "baseprice": 1000,
  "costPrice": 500,
  "nominalMaxPower": 500,
  "nominalOutputPower": 10,
  "height": 10,
  "width": 10,
  "lenght": 10,
  "weight": 10,
  "volume": 10,
  "featured": true,
  "featuredEcommerce": true,
  "isToSell": true,
  "isToSellIntegrator": true,
  "isToSellOptions": {
    "separatedSales": true,
    "closedKitSales": true,
    "mountKitSales": true
  },
  "storeSellOptions": {
    "separatedSales": true,
    "closedKitSales": true
  },
  "ecommerceSellOptions": {
    "separatedSales": true,
    "closedKitSales": true
  },
  "inventory": {
    "current": 100,
    "reserved": 50,
    "minimum": 0
  },
  "inventoryByCenter": [
    {
      "center": "CD001",
      "current": 100,
      "reserved": 50,
      "minimum": 0
    }
  ],
  "moduleSpecifications": {
    "ratedMaximumPower": 500,
    "efficiency": 10,
    "openCircuitVoltage": 40.5,
    "shortCircuitCurrent": 9.5,
    "maximumPowerVoltage": 33.5,
    "maximumPowerCurrent": 8.5,
    "cellType": "mono"
  },
  "inverterSpecifications": {
    "inverterType": "Tipo de inversor",
    "connectionType": "Tipo de ligação",
    "maximumInputPower": 10,
    "maximumInputPowerPerString": 500,
    "startVoltage": 100,
    "minimumMPPTVoltage": 150,
    "maximumMPPTVoltage": 1000,
    "mpptAmount": 2,
    "ratedOutputPower": 10,
    "ratedOutputVoltage": 400,
    "maximumOutputCurrent": 50,
    "maximumInputCurrentPerMPPT": [
      20
    ],
    "maximumInputCurrent": [
      40
    ],
    "stringsPerMPPT": [
      20
    ],
    "maximumCurrentDCConnector": [
      20
    ],
    "maximumCurrent": [
      20
    ],
    "solarEdgeSpecifications": {
      "compatibleInverters": [
        1
      ],
      "minimumStringLength": [
        1
      ],
      "maximumStringLength": [
        1
      ],
      "maximumContinuousPowerPerString": [
        5000
      ],
      "maximumConnectedPowerPer2String": [
        5000
      ],
      "maximumConnectedPowerPerString": [
        5000
      ],
      "maximumConnectedPowerPer3String": [
        5000
      ],
      "maximumConnectedPowerPer4String": [
        5000
      ]
    }
  },
  "complementaryEquipmentSpecifications": {
    "category": {
      "id": "200000000",
      "name": "Categoria",
      "type": "Tipo da categoria"
    }
  },
  "stringBoxSpecifications": {
    "inputAmount": [
      1
    ],
    "outputAmount": [
      1
    ],
    "maximumStringVoltage": 1000,
    "maximumStringCurrent": 20
  },
  "customData": [
    {
      "key": "<string>",
      "value": "0000",
      "type": "text"
    }
  ]
}

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

string

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

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

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

featured

boolean

Example:

true

featuredEcommerce

boolean

Example:

true

isToSell

boolean

Example:

true

isToSellIntegrator

boolean

Example:

true

isToSellOptions

object

Show child attributes

isToSellOptions.separatedSales

boolean

Example:

true

isToSellOptions.closedKitSales

boolean

Example:

true

isToSellOptions.mountKitSales

boolean

Example:

true

storeSellOptions

object

Show child attributes

storeSellOptions.separatedSales

boolean

Example:

true

storeSellOptions.closedKitSales

boolean

Example:

true

ecommerceSellOptions

object

Show child attributes

ecommerceSellOptions.separatedSales

boolean

Example:

true

ecommerceSellOptions.closedKitSales

boolean

Example:

true

inventory

object

Show child attributes

inventory.current

number

Example:

100

inventory.reserved

number

Example:

50

inventory.minimum

number

Example:

0

inventoryByCenter

object[]

Show child attributes

inventoryByCenter.center

string

Example:

"CD001"

inventoryByCenter.current

number

Example:

100

inventoryByCenter.reserved

number

Example:

50

inventoryByCenter.minimum

number

Example:

0

moduleSpecifications

object

Show child attributes

moduleSpecifications.ratedMaximumPower

number

Example:

500

moduleSpecifications.efficiency

number

Example:

10

moduleSpecifications.openCircuitVoltage

number

Example:

40.5

moduleSpecifications.shortCircuitCurrent

number

Example:

9.5

moduleSpecifications.maximumPowerVoltage

number

Example:

33.5

moduleSpecifications.maximumPowerCurrent

number

Example:

8.5

moduleSpecifications.cellType

string

Example:

"mono"

inverterSpecifications

object

Show child attributes

inverterSpecifications.inverterType

string

Example:

"Tipo de inversor"

inverterSpecifications.connectionType

string

Example:

"Tipo de ligação"

inverterSpecifications.maximumInputPower

number

Example:

10

inverterSpecifications.maximumInputPowerPerString

number

Example:

500

inverterSpecifications.startVoltage

number

Example:

100

inverterSpecifications.minimumMPPTVoltage

number

Example:

150

inverterSpecifications.maximumMPPTVoltage

number

Example:

1000

inverterSpecifications.mpptAmount

number

Example:

2

inverterSpecifications.ratedOutputPower

number

Example:

10

inverterSpecifications.ratedOutputVoltage

number

Example:

400

inverterSpecifications.maximumOutputCurrent

number

Example:

50

inverterSpecifications.maximumInputCurrentPerMPPT

number[]

inverterSpecifications.maximumInputCurrent

number[]

inverterSpecifications.stringsPerMPPT

number[]

inverterSpecifications.maximumCurrentDCConnector

number[]

inverterSpecifications.maximumCurrent

number[]

inverterSpecifications.solarEdgeSpecifications

object

Show child attributes

inverterSpecifications.solarEdgeSpecifications.compatibleInverters

string[]

inverterSpecifications.solarEdgeSpecifications.minimumStringLength

number[]

inverterSpecifications.solarEdgeSpecifications.maximumStringLength

number[]

inverterSpecifications.solarEdgeSpecifications.maximumContinuousPowerPerString

number[]

inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPer2String

number[]

inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPerString

number[]

inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPer3String

number[]

inverterSpecifications.solarEdgeSpecifications.maximumConnectedPowerPer4String

number[]

complementaryEquipmentSpecifications

object

Show child attributes

complementaryEquipmentSpecifications.category

object

Show child attributes

complementaryEquipmentSpecifications.category.id

string

Example:

"200000000"

complementaryEquipmentSpecifications.category.name

string

Example:

"Categoria"

complementaryEquipmentSpecifications.category.type

string

Example:

"Tipo da categoria"

stringBoxSpecifications

object

Show child attributes

stringBoxSpecifications.inputAmount

number[]

stringBoxSpecifications.outputAmount

number[]

stringBoxSpecifications.maximumStringVoltage

number

Example:

1000

stringBoxSpecifications.maximumStringCurrent

number

Example:

20

customData

object[]

Show child attributes

customData.key

string

Código de identificação do campo

customData.value

default:0000

Texto aberto

customData.type

enum<string>

Tipo do campo

Available options:

text,

date,

integer,

decimal,

currency,

currencyGeneric,

singleSelect,

multiSelect

Cria uma ou mais empresas de energia Atualiza o preço base e de custo de um ou mais equipamentos

⌘I

Visão Geral

Requests

Empresas

Produtos

Campos customizados

Retorna informações sobre os equipamentos

Authorizations

Path Parameters

Query Parameters

Response