v1

latestOpenAPI 3.0.02026-07-24102197.9 KB

DetailsAPI

Detalhes do pacote

Recupera detalhes de um pacote a partir das informações de CompanyID e TrackingCode.

get/v1/companies/{company_id}/packages/{tracking_code}

Path parameters

company_idstring required

Identificador do embarcador.

tracking_codestring required

Código de rastreio de um pacote.

Response

Example response

{
  "packages": [
    {
      "loggiKey": "KIF511LG3LGGA3U8G28B4200NA",
      "trackingCode": "AM1007503594LG",
      "barcode": "LG3LGGA3U8G28B4200NA",
      "status": {
        "code": 6,
        "highLevelStatus": "Com problema",
        "description": "Algo deu errado e o pacote está parado. O remetente precisa resolver o problema.",
        "actionRequired": {
          "reasonDescription": "Confira se está tudo certo com as informações do destinatário. Se tiver errado, corrija ou interrompa o envio.",
          "reasonLabel": "Aguardando tratativa"
        },
        "pickupAgency": {
          "address": "RUA ANTONIO LEITE DE GOIS, S/N",
          "city": "Imaculada",
          "state": "PB",
          "postalCode": "58745971"
        }
      },
      "destination": {
        "recipient": {
          "name": "Ana Carvalho da Silva",
          "phone": "51999897161",
          "nif": "02628794098"
        },
        "postalAddress": {
          "regionCode": "BR",
          "postalCode": "01234000",
          "addressLines": [
            "Rua Monte Sinai, 105 - Jardim do Vale, Vila Velha - ES, 29113-240, Brasil - H 402"
          ]
        }
      },
      "dimension": {
        "weightG": 100,
        "lengthCm": 10,
        "widthCm": 10,
        "heightCm": 10
      },
      "invoice": {
        "series": "123",
        "number": "1234",
        "key": "35170412514847000173550000005540001005541769",
        "totalValue": "664.20"
      },
      "origin": {
        "postalCode": "01234000"
      },
      "receiver": {
        "name": "Maria das Dores"
      },
      "pricing": {
        "amount": {
          "currencyCode": "BRL",
          "units": "7",
          "nanos": 520000000
        }
      },
      "redispatch": {
        "barcode": "NEW-BARCODE"
      },
      "direction": {
        "type": {
          "description": "Pacote em devolução"
        },
        "reason": {
          "description": "Endereço errado"
        },
        "returnAddress": {
          "regionCode": "BR",
          "postalCode": "01234000",
          "addressLines": [
            "Alameda Santos, 2400 - Jardim Paulista, São Paulo - SP, 01418-200, Brasil - 8 andar"
          ]
        }
      },
      "deliveryInformation": {
        "receiverName": "Maria das Dores",
        "receiverDocument": "123456789-01",
        "locationDescription": "CONCIERGE",
        "links": [
          {
            "rel": "digital_signature",
            "href": "http://www.loggi.com"
          }
        ]
      },
      "pickup_receipt": {
        "driver_name": "Leonardo Caprio",
        "license_plate": "ABC4E67",
        "transport_type": 1
      },
      "volumetric_info": {
        "consideredWeightG": 4008,
        "integration_values": {
          "cubicWeightG": 167,
          "dimensions": {
            "weightG": 100,
            "lengthCm": 10,
            "widthCm": 10,
            "heightCm": 10
          }
        },
        "measured_values": {
          "cubicWeightG": 4008,
          "dimensions": {
            "weightG": 3200,
            "lengthCm": 20,
            "widthCm": 30,
            "heightCm": 40
          }
        }
      }
    }
  ]
}