Skip to content

Pesquisar entregas

POST
/packages/search

Retorna as entregas que tenham os parâmetros pesquisados

Autorizações

Bearer

Generate a token

TipoHTTP (bearer)

Parâmetros

Parâmetros de Cabeçalho

Community-id*

Identificador da comunidade

Tipostring
Obrigatório
Exemplo"test"

Corpo da Requisição

application/json
JSON
{
"filter": {
"filters": [
{
"path": "string",
"value": "string",
"comparison": "string"
}
]
}
}

Respostas

Lista das entregas encontradas

application/json
JSON
[
{
"saleId": "5bb2575199d7179dfe85be02",
"items": [
],
"carrierKind": "custom",
"carrierId": "5bb2575199d7179dfe85be02",
"status": "ready_to_pack",
"notifyEmail": true,
"reversed": false,
"trackingCode": "SL123456789BR",
"trackingUrl": "https://rastreamento.correios.com.br",
"expectedDeliveryDate": "2020-12-25T15:34:11.118Z",
"statusNote": "Pacote pronto para envio",
"statusDate": "2020-12-25T15:34:11.118Z",
"statusTransitions": [
{
"status": "ready_to_pack",
"createdAt": "2020-12-25T15:34:11.118Z",
"note": "Pacote pronto para envio"
}
],
"pickUp": false,
"pickUpLocation": {
"title": "Casa",
"code": "74482-290",
"address": "Rua São José",
"address2": "BL 2, AP 42",
"number": "891",
"district": "Leblon",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BR",
"default": true
}
}
]

Exemplos

cURL
JavaScript
PHP
Python