--- title: "Detalhes do pacote" method: GET path: "/v1/companies/{company_id}/packages/{tracking_code}" tags: ["DetailsAPI"] --- # Detalhes do pacote `GET /v1/companies/{company_id}/packages/{tracking_code}` Recupera detalhes de um pacote a partir das informações de CompanyID e TrackingCode. ## Path parameters - `company_id` string, required - `tracking_code` string, required ## Response `200` - V1PackageDetailsResponse — Objeto que retorna todos os pacotes que são identificados pelo CompanyID e TrackingCode passados na requisição. - `packages` object[] - `loggiKey` string — Chave que identifica unicamente um pacote dentro da Loggi. - `trackingCode` string — Código de rastreio de um pacote. - `barcode` string — Código de barras atual do pacote. - `status` object — Objeto que representa as informações do status de um pacote. - `code` integer — Código numérico referente ao estado do pacote. - `highLevelStatus` string — Status geral do pacote em formato legível. - `description` string — Breve descrição do status do pacote. - `actionRequired` object — Objeto que representa uma ação que deve ser tomada pelo embarcador para continuar a entrega. - `reasonDescription` string — Breve descrição da ação que precisa ser tomada pelo embarcador. - `reasonLabel` string — Rótulo da ação que precisa ser tomada pelo embarcador. - `updatedTime` string, date-time — Data que o pacote entrou no status atual. - `pickupAgency` object — 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. - `address` string — Logradouro da agência dos Correios, incluindo número quando informado. - `city` string — Cidade onde a agência dos Correios está localizada. - `state` string — Unidade federativa (UF) onde a agência dos Correios está localizada. - `postalCode` string — CEP da agência dos Correios. No Brasil, usa-se o formato de 8 dígitos, sem hífen. - `destination` object - `recipient` object - `name` string — Nome do destinatário associado ao pacote. - `phone` string — Número de telefone do desinatário associado ao pacote. - `nif` string — Número de identificação fiscal do destinatário associado ao pacote. - `postalAddress` object - `revision` integer — Número da versão da resposta de endereço postal do Google. 0 significa que é a versão mais atual. - `regionCode` string — Código da região associado ao endereço postal gerado pelo Google. - `languageCode` string — Código que representa o idioma encontrado no endereço. Não usado pela Loggi no momento. - `postalCode` string — Código postal do endereço enviado. No Brasil, usa-se o CEP. - `sortingCode` string — 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` string — Área administrativa do endereço. No Brasil, equivale à unidade federativa (UF). - `locality` string — Localidade do endereço destinatário. No Brasil, equivale à cidade. Retorna vazio na maioria das respostas. - `sublocality` string — Sublocalidade do endereço destinatário. No Brasil, equivale ao bairro. Retorna vazio na maioria das respostas. - `addressLines` string[] — Representação mais simples do endereço associado ao destinatário do pacote. Comumente associado ao formato inserido pelo usuário. Retorno obrigatório. - `recipients` string — Não utilizado pela Loggi no momento. - `organization` string — Nâo utilizado pela Loggi no momento. - `promisedDate` string, date — Estimativa de data para a primeira tentativa de entrega. - `dimension` object - `weightG` integer — Peso do pacote, representado em gramas (g). - `lengthCm` integer — Comprimento do pacote, representado em centímetros (cm). - `widthCm` integer — Largura do pacote, representado em centímetros (cm). - `heightCm` integer — Altura do pacote, representado em centímetros (cm). - `invoice` object - `series` string — Série da Nota Fiscal associada ao pacote. - `number` string — Número da Nota Fiscal associada ao pacote. - `key` string — Chave da Nota Fiscal Eletrônica (NFe) associada ao pacote, formada por 44 dígitos numéricos ou alfanuméricos. - `totalValue` string — Valor total emitido na Nota Fiscal associada ao pacote. - `origin` object - `postalCode` string — Código postal do endereço enviado. No Brasil, usa-se o CEP. - `receiver` object - `name` string — Nome de quem recebeu o pacote no momento de sua entrega. Não necessariamente é igual ao nome do destinatário. - `pricing` object — Objeto que representa as informações de precificação do envio de um pacote. - `amount` object — Objeto com as informações do preço do envio de pacote. - `currencyCode` string — Código de 3 letras que estabelece a moeda da precificação do envio do pacote, definido na ISO4217 - `units` string — Componente inteiro do preço do envio do pacote. Um envio com preço de 7,52 teria "7" units. - `nanos` integer — 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` integer — Representação númerica do SLO (Service Level Objective) associado ao pacote. Comumente 0 ou 1. - `redispatch` object - `barcode` string — Código de barras associado à operação de redespacho do pacote para os Correios. - `direction` object - `type` object - `code` integer — Código indicando o sentido do pacote. - `description` string — Mensagem que identifica o sentido do pacote. - `reason` object - `code` integer — Código indicando a razão pela qual o pacote teve o sentido alterado. - `description` string — Mensagem que descreve a razão pela qual o pacote teve o seu sentido alterado. - `returnAddress` object — Endereço de devolução relacionado ao pacote. Preenchido somente se o pacote está na direção de devolução. - `revision` integer — Número da versão da resposta de endereço postal do Google. 0 significa que é a versão mais atual. - `regionCode` string — Código da região associado ao endereço postal gerado pelo Google. - `languageCode` string — Código que representa o idioma encontrado no endereço. Não usado pela Loggi no momento. - `postalCode` string — Código postal do endereço de devolução. No Brasil, usa-se o CEP. - `sortingCode` string — 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` string — Área administrativa do endereço de devolução. No Brasil, equivale à unidade federativa (UF). - `locality` string — Localidade do endereço de devolução. No Brasil, equivale à cidade. Retorna vazio na maioria das respostas. - `sublocality` string — Sublocalidade do endereço de devolução. No Brasil, equivale ao bairro. Retorna vazio na maioria das respostas. - `addressLines` string[] — Representação mais simples do endereço associado à devolução do pacote. - `recipients` string — Não utilizado pela Loggi no momento. - `organization` string — Nâo utilizado pela Loggi no momento. - `deliveryInformation` object - `receiverName` string — Nome de quem recebeu o pacote no momento de sua entrega. Não necessariamente é igual ao nome do destinatário. - `receiverDocument` string — Número do documento identificador de quem recebeu o pacote no momento de sua entrega. - `locationDescription` string — Descrição detalhada do local onde o pacote foi entregue. - `links` object[] - `rel` string — Identificador interno para definir a informação fornecida a partir do arquivo. - `href` string — URL com o arquivo referente à descrição da informação fornecida por quem recebeu. - `pickup_receipt` object - `driver_name` string — Nome da pessoa que fez a coleta. - `license_plate` string — Placa do veículo de coleta. - `pickup_end_time` string, date-time — Timestamp do momento da coleta. - `transport_type` integer — Código numérico referente ao tipo de veículo que realizou a coleta. - `volumetric_info` object — Informações de volume do pacote. - `consideredWeightG` integer — Peso que vai ser considerado para o cálculo final da cobrança, representado em gramas (g). - `integration_values` object — Dados fornecidos pelo embarcador no envio do pacote. - `cubicWeightG` integer — Espaço real ocupado pelo pacote, com base na relação entre o peso e o volume da carga, representado em gramas (g). - `dimensions` object - `weightG` integer — Peso do pacote, representado em gramas (g). - `lengthCm` integer — Comprimento do pacote, representado em centímetros (cm). - `widthCm` integer — Largura do pacote, representado em centímetros (cm). - `heightCm` integer — Altura do pacote, representado em centímetros (cm). - `measured_values` object — Dados revisados pela Loggi para pacotes medidos e pesados em nossas bases. - `cubicWeightG` integer — Espaço real ocupado pelo pacote, com base na relação entre o peso e o volume da carga, representado em gramas (g). - `dimensions` object - `weightG` integer — Peso do pacote, representado em gramas (g). - `lengthCm` integer — Comprimento do pacote, representado em centímetros (cm). - `widthCm` integer — Largura do pacote, representado em centímetros (cm). - `heightCm` integer — Altura do pacote, representado em centímetros (cm). - `requestTime` string, date-time — Timestamp do momento da requisição. ## Other responses - `400` — Mensagem do cliente não segue a especificação - `401` — Falha de autenticação - `403` — Sem autorização para acessar o serviço - `404` — Recurso não encontrado - `429` — Requisições massivas bloqueadas - `500` — Erro interno - `503` — Serviço temporariamente indisponível --- [API](https://skmtc.net/loggi/apis/authentication.md) · [All operations](https://skmtc.net/loggi/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/loggi/authentication/revisions/46512f6e2419/schema)