{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/loggi/main/json-schema/loggi-v1-package-details-response-schema.json", "title": "v1PackageDetailsResponse", "description": "Objeto que retorna todos os pacotes que são identificados pelo CompanyID e TrackingCode passados na requisição.", "x-generated": "2026-10-14", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/loggi-package-details-openapi.yml#/components/schemas/v1PackageDetailsResponse", "type": "object", "properties": { "packages": { "type": "array", "items": { "type": "object", "properties": { "loggiKey": { "type": "string", "description": "Chave que identifica unicamente um pacote dentro da Loggi." }, "trackingCode": { "type": "string", "description": "Código de rastreio de um pacote." }, "barcode": { "type": "string", "description": "Código de barras atual do pacote." }, "status": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "description": "Código numérico referente ao estado do pacote." }, "highLevelStatus": { "type": "string", "description": "Status geral do pacote em formato legível." }, "description": { "type": "string", "description": "Breve descrição do status do pacote." }, "actionRequired": { "type": "object", "properties": { "reasonDescription": { "type": "string", "description": "Breve descrição da ação que precisa ser tomada pelo embarcador." }, "reasonLabel": { "type": "string", "description": "Rótulo da ação que precisa ser tomada pelo embarcador." } }, "description": "Objeto que representa uma ação que deve ser tomada pelo embarcador para continuar a entrega." }, "updatedTime": { "type": "string", "format": "date-time", "description": "Data que o pacote entrou no status atual." }, "pickupAgency": { "type": "object", "description": "Endereço da agência dos Correios onde o pacote está disponível para retirada. Preenchido somente para pacotes redespachados e quando o status é Retirar nos correios.", "properties": { "address": { "type": "string", "description": "Logradouro da agência dos Correios, incluindo número quando informado." }, "city": { "type": "string", "description": "Cidade onde a agência dos Correios está localizada." }, "state": { "type": "string", "description": "Unidade federativa (UF) onde a agência dos Correios está localizada." }, "postalCode": { "type": "string", "description": "CEP da agência dos Correios. No Brasil, usa-se o formato de 8 dígitos, sem hífen." } } } }, "description": "Objeto que representa as informações do status de um pacote." }, "destination": { "type": "object", "properties": { "recipient": { "type": "object", "properties": { "name": { "type": "string", "description": "Nome do destinatário associado ao pacote." }, "phone": { "type": "string", "description": "Número de telefone do desinatário associado ao pacote." }, "nif": { "type": "string", "description": "Número de identificação fiscal do destinatário associado ao pacote." } } }, "postalAddress": { "type": "object", "properties": { "revision": { "type": "integer", "description": "Número da versão da resposta de endereço postal do Google. 0 significa que é a versão mais atual." }, "regionCode": { "type": "string", "description": "Código da região associado ao endereço postal gerado pelo Google." }, "languageCode": { "type": "string", "description": "Código que representa o idioma encontrado no endereço. Não usado pela Loggi no momento." }, "postalCode": { "type": "string", "description": "Código postal do endereço enviado. No Brasil, usa-se o CEP." }, "sortingCode": { "type": "string", "description": "Código de ordenação usado para fins postais em alguns países. Não se aplica ao Brasil, e não usado pela Loggi no momento." }, "administrativeArea": { "type": "string", "description": "Área administrativa do endereço. No Brasil, equivale à unidade federativa (UF)." }, "locality": { "type": "string", "description": "Localidade do endereço destinatário. No Brasil, equivale à cidade. Retorna vazio na maioria das respostas." }, "sublocality": { "type": "string", "description": "Sublocalidade do endereço destinatário. No Brasil, equivale ao bairro. Retorna vazio na maioria das respostas." }, "addressLines": { "description": "Representação mais simples do endereço associado ao destinatário do pacote. Comumente associado ao formato inserido pelo usuário. Retorno obrigatório.", "type": "array", "items": { "type": "string" } }, "recipients": { "type": "string", "description": "Não utilizado pela Loggi no momento." }, "organization": { "type": "string", "description": "Nâo utilizado pela Loggi no momento." } } } } }, "promisedDate": { "type": "string", "format": "date", "description": "Estimativa de data para a primeira tentativa de entrega." }, "dimension": { "type": "object", "properties": { "weightG": { "type": "integer", "description": "Peso do pacote, representado em gramas (g)." }, "lengthCm": { "type": "integer", "description": "Comprimento do pacote, representado em centímetros (cm)." }, "widthCm": { "type": "integer", "description": "Largura do pacote, representado em centímetros (cm)." }, "heightCm": { "type": "integer", "description": "Altura do pacote, representado em centímetros (cm)." } } }, "invoice": { "type": "object", "properties": { "series": { "type": "string", "description": "Série da Nota Fiscal associada ao pacote." }, "number": { "type": "string", "description": "Número da Nota Fiscal associada ao pacote." }, "key": { "type": "string", "description": "Chave da Nota Fiscal Eletrônica (NFe) associada ao pacote, formada por 44 dígitos numéricos ou alfanuméricos." }, "totalValue": { "type": "string", "description": "Valor total emitido na Nota Fiscal associada ao pacote." } } }, "origin": { "type": "object", "properties": { "postalCode": { "type": "string", "description": "Código postal do endereço enviado. No Brasil, usa-se o CEP." } } }, "receiver": { "type": "object", "properties": { "name": { "type": "string", "description": "Nome de quem recebeu o pacote no momento de sua entrega. Não necessariamente é igual ao nome do destinatário." } } }, "pricing": { "type": "object", "description": "Objeto que representa as informações de precificação do envio de um pacote.", "properties": { "amount": { "type": "object", "description": "Objeto com as informações do preço do envio de pacote.", "properties": { "currencyCode": { "type": "string", "description": "Código de 3 letras que estabelece a moeda da precificação do envio do pacote, definido na ISO4217" }, "units": { "type": "string", "description": "Componente inteiro do preço do envio do pacote. Um envio com preço de 7,52 teria \"7\" units." }, "nanos": { "type": "integer", "format": "int32", "description": "Componente não inteiro do preço do envio do pacote multiplicado por 10⁹. Um envio com preço de 7,52 teria 520000000 nanos." } } } } }, "slo": { "type": "integer", "description": "Representação númerica do SLO (Service Level Objective) associado ao pacote. Comumente 0 ou 1." }, "redispatch": { "type": "object", "properties": { "barcode": { "type": "string", "description": "Código de barras associado à operação de redespacho do pacote para os Correios." } } }, "direction": { "type": "object", "properties": { "type": { "type": "object", "properties": { "code": { "type": "integer", "description": "Código indicando o sentido do pacote." }, "description": { "type": "string", "description": "Mensagem que identifica o sentido do pacote." } } }, "reason": { "type": "object", "properties": { "code": { "type": "integer", "description": "Código indicando a razão pela qual o pacote teve o sentido alterado." }, "description": { "type": "string", "description": "Mensagem que descreve a razão pela qual o pacote teve o seu sentido alterado." } } }, "returnAddress": { "type": "object", "description": "Endereço de devolução relacionado ao pacote. Preenchido somente se o pacote está na direção de devolução.", "properties": { "revision": { "type": "integer", "description": "Número da versão da resposta de endereço postal do Google. 0 significa que é a versão mais atual." }, "regionCode": { "type": "string", "description": "Código da região associado ao endereço postal gerado pelo Google." }, "languageCode": { "type": "string", "description": "Código que representa o idioma encontrado no endereço. Não usado pela Loggi no momento." }, "postalCode": { "type": "string", "description": "Código postal do endereço de devolução. No Brasil, usa-se o CEP." }, "sortingCode": { "type": "string", "description": "Código de ordenação usado para fins postais em alguns países. Não se aplica ao Brasil, e não usado pela Loggi no momento." }, "administrativeArea": { "type": "string", "description": "Área administrativa do endereço de devolução. No Brasil, equivale à unidade federativa (UF)." }, "locality": { "type": "string", "description": "Localidade do endereço de devolução. No Brasil, equivale à cidade. Retorna vazio na maioria das respostas." }, "sublocality": { "type": "string", "description": "Sublocalidade do endereço de devolução. No Brasil, equivale ao bairro. Retorna vazio na maioria das respostas." }, "addressLines": { "description": "Representação mais simples do endereço associado à devolução do pacote.", "type": "array", "items": { "type": "string" } }, "recipients": { "type": "string", "description": "Não utilizado pela Loggi no momento." }, "organization": { "type": "string", "description": "Nâo utilizado pela Loggi no momento." } } } } }, "deliveryInformation": { "type": "object", "properties": { "receiverName": { "type": "string", "description": "Nome de quem recebeu o pacote no momento de sua entrega. Não necessariamente é igual ao nome do destinatário." }, "receiverDocument": { "type": "string", "description": "Número do documento identificador de quem recebeu o pacote no momento de sua entrega." }, "locationDescription": { "type": "string", "description": "Descrição detalhada do local onde o pacote foi entregue." }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "Identificador interno para definir a informação fornecida a partir do arquivo." }, "href": { "type": "string", "description": "URL com o arquivo referente à descrição da informação fornecida por quem recebeu." } } } } } }, "pickup_receipt": { "type": "object", "properties": { "driver_name": { "type": "string", "description": "Nome da pessoa que fez a coleta." }, "license_plate": { "type": "string", "description": "Placa do veículo de coleta." }, "pickup_end_time": { "type": "string", "format": "date-time", "description": "Timestamp do momento da coleta." }, "transport_type": { "type": "integer", "format": "int64", "description": "Código numérico referente ao tipo de veículo que realizou a coleta." } } }, "volumetric_info": { "type": "object", "description": "Informações de volume do pacote.", "properties": { "consideredWeightG": { "type": "integer", "description": "Peso que vai ser considerado para o cálculo final da cobrança, representado em gramas (g)." }, "integration_values": { "type": "object", "description": "Dados fornecidos pelo embarcador no envio do pacote.", "properties": { "cubicWeightG": { "type": "integer", "description": "Espaço real ocupado pelo pacote, com base na relação entre o peso e o volume da carga, representado em gramas (g)." }, "dimensions": { "type": "object", "properties": { "weightG": { "type": "integer", "description": "Peso do pacote, representado em gramas (g)." }, "lengthCm": { "type": "integer", "description": "Comprimento do pacote, representado em centímetros (cm)." }, "widthCm": { "type": "integer", "description": "Largura do pacote, representado em centímetros (cm)." }, "heightCm": { "type": "integer", "description": "Altura do pacote, representado em centímetros (cm)." } } } } }, "measured_values": { "type": "object", "description": "Dados revisados pela Loggi para pacotes medidos e pesados em nossas bases.", "properties": { "cubicWeightG": { "type": "integer", "description": "Espaço real ocupado pelo pacote, com base na relação entre o peso e o volume da carga, representado em gramas (g)." }, "dimensions": { "type": "object", "properties": { "weightG": { "type": "integer", "description": "Peso do pacote, representado em gramas (g)." }, "lengthCm": { "type": "integer", "description": "Comprimento do pacote, representado em centímetros (cm)." }, "widthCm": { "type": "integer", "description": "Largura do pacote, representado em centímetros (cm)." }, "heightCm": { "type": "integer", "description": "Altura do pacote, representado em centímetros (cm)." } } } } } } }, "requestTime": { "type": "string", "format": "date-time", "description": "Timestamp do momento da requisição." } }, "description": "Objeto que representa os dados de rastreio de um pacote." } } } }