Retorna os dados dos orçamentos ou dos pedidos

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

import requests

url = "https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "Identificador (ID) da requisição",
  "name": "Nome da requisição",
  "code": "200000000",
  "kind": "Kit Personalizado",
  "totalPower": 22.75,
  "budgetCreated": "2022-01-01T12:00:00.000Z",
  "orderCreated": "2022-01-01T12:00:00.000Z",
  "dealStatus": "Novo",
  "stockStatus": "reserved",
  "originalValue": 10000,
  "discount": 10,
  "surcharge": 10,
  "finalValue": 9000,
  "differenceWithPaymentConditionApplied": 0,
  "notes": "<p>Anotações internas</p>",
  "addedBy": {
    "name": "Nome",
    "surname": "Sobrenome",
    "email": "email@email.com",
    "cellphone": "(00) 00000-0000"
  },
  "payment": {
    "type": "pix",
    "condition": {
      "name": "À vista",
      "quantityOfInstallments": 1,
      "conditionType": "notUpdate",
      "modifierType": "percentage",
      "value": 10
    },
    "transactionStatus": "pending",
    "transactionId": "AAABBB123AA",
    "authorizationNsu": "123123",
    "authorizationCode": "123123",
    "paidAt": "2025-01-01T00:00",
    "creditCard": {
      "brand": "visa",
      "last4digits": "1234",
      "first6digits": "123456",
      "holderName": "John Doe"
    },
    "status": "notRequested",
    "description": "Codigo PIX: XYZ",
    "files": [
      {
        "path": "<string>",
        "originalName": "<string>"
      }
    ],
    "links": [
      {
        "id": "<string>",
        "path": "/api/v2/payments/{id}",
        "method": "GET"
      }
    ]
  },
  "responsible": {
    "name": "Nome do responsável",
    "surname": "Sobrenome do responsável",
    "email": "email@email.com",
    "cellphone": "(00) 00000-0000"
  },
  "company": {
    "cnpj": "00.000.000/0000-00",
    "cpf": "000.000.000-00",
    "fantasyName": "Nome fantasia",
    "companyName": "Razão social",
    "mainContact": {
      "name": "Nome",
      "surname": "Sobrenome",
      "email": "email@email.com",
      "cellphone": "(00) 00000-0000"
    },
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y"
    }
  },
  "products": [
    {
      "type": "module",
      "productCode": "codigo123",
      "name": "Nome do produto",
      "quantity": 10,
      "singlePrice": 1000,
      "totalPrice": 10000,
      "structure": {
        "name": "Cerâmica Colonial",
        "type": "cerâmica",
        "amount": 1,
        "price": 1000
      },
      "center": {
        "name": "Primeiro CD",
        "code": "CD001"
      },
      "dimensions": {
        "length_MM": 100,
        "width_MM": 100,
        "height_MM": 100,
        "weight_KG": 1,
        "volume_M3": 100
      }
    }
  ],
  "files": [
    {
      "category": "CPF",
      "uploadedFiles": [
        "CPF.png"
      ]
    }
  ],
  "customForm": [
    {
      "question": "Data de nascimento",
      "answer": "01/01/1900"
    }
  ],
  "structure": [
    {
      "kind": "Sem Estrutura",
      "arrangements": [
        {
          "linesAmount": 2,
          "modulesByLine": 25,
          "orientation": "Retrato / Paisagem"
        }
      ]
    }
  ],
  "freight": {
    "type": "CIF / FOB",
    "zoneType": "Rural / Urbana",
    "timeRestriction": "Restrição de horário",
    "truckPossible": "Sim / Não",
    "price": 1000,
    "integrationData": {
      "id": "ID da integração (se houver)",
      "name": "Nome da integração",
      "logisticProviderName": "Nome do provedor logístico"
    },
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y"
    }
  },
  "invoice": {
    "razaoSocial": "Razão Social",
    "nomeFantasia": "Nome Fantasia",
    "cnpj": "00.000.000/0000-00",
    "temInscricaoEstadual": "sim",
    "ie": "000000000",
    "cpf": "000.000.000-00",
    "rg": "0000000",
    "telephone": "(00) 0000-0000",
    "email": "email@email.com",
    "originalInvoiceValue": 100000,
    "serviceToAddInvoiceValue": 10000,
    "requestedInvoiceValue": 120000,
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y"
    }
  },
  "apiSent": true,
  "apiSentUpdated": "2022-01-01T12:00:00.000Z",
  "billingDate": "2025-01-01",
  "customData": [
    {
      "key": "<string>",
      "value": "0000",
      "type": "text"
    }
  ],
  "removed": false
}

Requests

Retorna os dados dos orçamentos ou dos pedidos

Retorna uma lista dos orçamentos/pedidos cadastrados na plataforma ordenados pela data de criação, sendo o primeiro registro o orçamento/pedido criado mais recentemente. Para a pesquisa retornar exclusivamente os novos registros de orçamentos/pedidos, ou seja, todos os orçamentos/pedidos que foram criados ou que tiveram algum de seus dados alterados desde a última requisição, deve-se realizar a pesquisa sem a utilização de parâmetros de pesquisa.

GET

requests

{requestType}

{pageNumber}

{pageLimit}

Retorna os dados dos orçamentos ou dos pedidos

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

import requests

url = "https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://backend-pied-prod.piedadmin.com.br/api/v2/requests/{requestType}/{pageNumber}/{pageLimit}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "Identificador (ID) da requisição",
  "name": "Nome da requisição",
  "code": "200000000",
  "kind": "Kit Personalizado",
  "totalPower": 22.75,
  "budgetCreated": "2022-01-01T12:00:00.000Z",
  "orderCreated": "2022-01-01T12:00:00.000Z",
  "dealStatus": "Novo",
  "stockStatus": "reserved",
  "originalValue": 10000,
  "discount": 10,
  "surcharge": 10,
  "finalValue": 9000,
  "differenceWithPaymentConditionApplied": 0,
  "notes": "<p>Anotações internas</p>",
  "addedBy": {
    "name": "Nome",
    "surname": "Sobrenome",
    "email": "email@email.com",
    "cellphone": "(00) 00000-0000"
  },
  "payment": {
    "type": "pix",
    "condition": {
      "name": "À vista",
      "quantityOfInstallments": 1,
      "conditionType": "notUpdate",
      "modifierType": "percentage",
      "value": 10
    },
    "transactionStatus": "pending",
    "transactionId": "AAABBB123AA",
    "authorizationNsu": "123123",
    "authorizationCode": "123123",
    "paidAt": "2025-01-01T00:00",
    "creditCard": {
      "brand": "visa",
      "last4digits": "1234",
      "first6digits": "123456",
      "holderName": "John Doe"
    },
    "status": "notRequested",
    "description": "Codigo PIX: XYZ",
    "files": [
      {
        "path": "<string>",
        "originalName": "<string>"
      }
    ],
    "links": [
      {
        "id": "<string>",
        "path": "/api/v2/payments/{id}",
        "method": "GET"
      }
    ]
  },
  "responsible": {
    "name": "Nome do responsável",
    "surname": "Sobrenome do responsável",
    "email": "email@email.com",
    "cellphone": "(00) 00000-0000"
  },
  "company": {
    "cnpj": "00.000.000/0000-00",
    "cpf": "000.000.000-00",
    "fantasyName": "Nome fantasia",
    "companyName": "Razão social",
    "mainContact": {
      "name": "Nome",
      "surname": "Sobrenome",
      "email": "email@email.com",
      "cellphone": "(00) 00000-0000"
    },
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y"
    }
  },
  "products": [
    {
      "type": "module",
      "productCode": "codigo123",
      "name": "Nome do produto",
      "quantity": 10,
      "singlePrice": 1000,
      "totalPrice": 10000,
      "structure": {
        "name": "Cerâmica Colonial",
        "type": "cerâmica",
        "amount": 1,
        "price": 1000
      },
      "center": {
        "name": "Primeiro CD",
        "code": "CD001"
      },
      "dimensions": {
        "length_MM": 100,
        "width_MM": 100,
        "height_MM": 100,
        "weight_KG": 1,
        "volume_M3": 100
      }
    }
  ],
  "files": [
    {
      "category": "CPF",
      "uploadedFiles": [
        "CPF.png"
      ]
    }
  ],
  "customForm": [
    {
      "question": "Data de nascimento",
      "answer": "01/01/1900"
    }
  ],
  "structure": [
    {
      "kind": "Sem Estrutura",
      "arrangements": [
        {
          "linesAmount": 2,
          "modulesByLine": 25,
          "orientation": "Retrato / Paisagem"
        }
      ]
    }
  ],
  "freight": {
    "type": "CIF / FOB",
    "zoneType": "Rural / Urbana",
    "timeRestriction": "Restrição de horário",
    "truckPossible": "Sim / Não",
    "price": 1000,
    "integrationData": {
      "id": "ID da integração (se houver)",
      "name": "Nome da integração",
      "logisticProviderName": "Nome do provedor logístico"
    },
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y"
    }
  },
  "invoice": {
    "razaoSocial": "Razão Social",
    "nomeFantasia": "Nome Fantasia",
    "cnpj": "00.000.000/0000-00",
    "temInscricaoEstadual": "sim",
    "ie": "000000000",
    "cpf": "000.000.000-00",
    "rg": "0000000",
    "telephone": "(00) 0000-0000",
    "email": "email@email.com",
    "originalInvoiceValue": 100000,
    "serviceToAddInvoiceValue": 10000,
    "requestedInvoiceValue": 120000,
    "address": {
      "CEP": "00000-000",
      "state": "SC",
      "city": "Nome da Cidade",
      "neighborhood": "Nome do Bairro",
      "patio": "Nome da Rua",
      "number": "1000",
      "complement": "Bloco X, Casa Y"
    }
  },
  "apiSent": true,
  "apiSentUpdated": "2022-01-01T12:00:00.000Z",
  "billingDate": "2025-01-01",
  "customData": [
    {
      "key": "<string>",
      "value": "0000",
      "type": "text"
    }
  ],
  "removed": false
}

🚀 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

requestType

enum<string>

required

Determina se será pesquisado orçamentos ou pedidos.

Available options:

order,

budget

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).

lastUpdateAfter

string

A pesquisa retorna registros atualizados pela última vez a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).

lastUpdateBefore

string

A pesquisa retorna registros atualizados pela última vez até esta data passada no parâmetro. Formato (AAAA-MM-DD).

code

string

A pesquisa retorna registros nos quais o código de orçamento/pedido 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 de orçamento/pedido 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…

powerGTE

number

A pesquisa retorna registros criados com potência em Wp superior ou igual à passada no parâmetro.

powerLTE

number

A pesquisa retorna registros criados com potência em Wp inferior ou igual à passada no parâmetro.

freightState

string

A pesquisa retorna registros criados com o estado do frete de entrega igual ao da Unidade Federativa passada no parâmetro. Formato (UF).

freightCity

string

A pesquisa retorna registros nos quais o nome da cidade do frete de entrega ou parte deste nome é igual ao passado no parâmetro.

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

companyCNPJ

string

A pesquisa retorna registros nos quais o CNPJ da empresa de energia solar ou parte deste CNPJ é igual ao passado no parâmetro. Formato (00.000.000/000-00).

Exemplo: Para a pesquisa retornar registros com o CNPJ 01.234.567/0001-89, pode-se passar tanto o parâmetro 01.234.567/0001-89, quanto os parâmetros 0, 1, 2, 3, 4, 01, 56, 0001, 567/0001…

responsibleEmail

string

A pesquisa retorna registros nos quais o e-mail do colaborador responsável pelo orçamento/pedido ou parte deste e-mail é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o e-mail email@email.com, pode-se passar tanto o parâmetro email@email.com, quanto os parâmetros e, m, a, @, ail, .com, email, @email.com…

removed

boolean

A pesquisa retorna os registros que foram removidos.

Response

string

Example:

"Identificador (ID) da requisição"

name

string

Example:

"Nome da requisição"

code

string

Example:

"200000000"

kind

string

Example:

"Kit Personalizado"

totalPower

number

Example:

22.75

budgetCreated

string

Example:

"2022-01-01T12:00:00.000Z"

orderCreated

string

Example:

"2022-01-01T12:00:00.000Z"

dealStatus

string

Example:

"Novo"

stockStatus

string

Example:

"reserved"

originalValue

number

Example:

10000

discount

number

Example:

10

surcharge

number

Example:

10

finalValue

number

Example:

9000

differenceWithPaymentConditionApplied

number

Diferença entre o valor do pedido/orçamento e o valor final com a forma de pagamento aplicada.

Example:

0

notes

string

Example:

"<p>Anotações internas</p>"

addedBy

object

Show child attributes

payment

object

Show child attributes

responsible

object

Show child attributes

company

object

Show child attributes

products

object[]

Show child attributes

files

object[]

Show child attributes

customForm

object[]

Show child attributes

structure

object[]

Show child attributes

freight

object

Show child attributes

invoice

object

Show child attributes

apiSent

boolean

Example:

true

apiSentUpdated

string

Example:

"2022-01-01T12:00:00.000Z"

billingDate

string

Example:

"2025-01-01"

customData

object[]

Show child attributes

removed

boolean

Example:

false

Visão Geral

Requests

Empresas

Equipamentos

Colaboradores

Pagamentos

Campos Customizados

Kits

Retorna os dados dos orçamentos ou dos pedidos

Authorizations

Path Parameters

Query Parameters

Response