---
agentTools:
projectIndex: https://docs.api.loggi.com/llms.txt
---
# Rastrear Pacote
Faz o rastreio de pacotes a partir das informações de CompanyID e TrackingCode.
### Teste abaixo o endpoint
⚠️ Os campos abaixo precisam ser preenchidos para realização dos testes de endpoint.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Tracking",
"version": "v1",
"description": "O rastreio de pacotes é um processo que se inicia com o recebimento de informações que identificam um pacote e termina com a entrega dos dados referentes ao status do pacote recebido."
},
"servers": [
{
"url": "https://stg.api.loggi.com"
},
{
"url": "https://api.loggi.com"
}
],
"paths": {
"/v1/companies/{company_id}/packages/{tracking_code}/tracking": {
"get": {
"summary": "Rastrear Pacote",
"description": "Faz o rastreio de pacotes a partir das informações de CompanyID e TrackingCode.\n\n### Teste abaixo o endpoint\n\n⚠️ Os campos abaixo precisam ser preenchidos para realização dos testes de endpoint.\n
",
"operationId": "TrackPackageTrackingCode",
"security": [
{
"OAuth2": []
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1TrackPackageTrackingCodeResponse"
}
}
}
},
"400": {
"description": "Mensagem do cliente não segue a especificação",
"content": {
"application/json": {
"examples": {
"invalid_argument": {
"value": {
"code": 3,
"message": "Mensagem do cliente não segue a especificação",
"details": []
}
},
"failed_preconditions": {
"value": {
"code": 9,
"message": "Request with invalid data",
"details": [
{
"@type": "type.googleapis.com/google.rpc.BadRequest",
"fieldViolations": [
{
"field": "loggi_key",
"description": "invalid format"
}
]
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"401": {
"description": "Falha de autenticação",
"content": {
"application/json": {
"example": {
"code": 16,
"message": "Falha de autenticação",
"details": []
},
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"403": {
"description": "Sem autorização para acessar o serviço",
"content": {
"application/json": {
"example": {
"code": 7,
"message": "Falha de autenticação",
"details": []
},
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"404": {
"description": "Recurso não encontrado",
"content": {
"application/json": {
"example": {
"code": 5,
"message": "Recurso não encontrado",
"details": []
},
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"429": {
"description": "Requisições massivas bloqueadas",
"content": {
"application/json": {
"example": {
"code": 8,
"message": "Requisições massivas bloqueadas",
"details": []
},
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"500": {
"description": "Erro interno",
"content": {
"application/json": {
"example": {
"code": 13,
"message": "Erro interno",
"details": []
},
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"503": {
"description": "Serviço temporariamente indisponível",
"content": {
"application/json": {
"example": {
"code": 14,
"message": "Serviço temporariamente indisponível",
"details": []
},
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
}
},
"parameters": [
{
"name": "company_id",
"in": "path",
"required": true,
"description": "Identificador do embarcador.",
"schema": {
"type": "string"
}
},
{
"name": "tracking_code",
"in": "path",
"required": true,
"description": "Código de rastreio de um pacote.",
"schema": {
"type": "string"
}
}
],
"tags": [
"TrackingAPI"
]
}
}
},
"components": {
"securitySchemes": {
"OAuth2": {
"type": "oauth2",
"description": "Autenticação OAuth 2.0 para clientes da API.",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.loggi.com/oauth2/token",
"scopes": {}
}
}
}
},
"schemas": {
"v1TrackPackageTrackingCodeResponse": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"loggiKey": {
"type": "string",
"description": "Chave que identifica unicamente um pacote dentro da Loggi.",
"example": "KIF511LG3LGGA3U8G28B4200NA"
},
"trackingCode": {
"type": "string",
"description": "Código de rastreio de um pacote.",
"example": "AM1007503594LG"
},
"barcode": {
"type": "string",
"description": "Código de barras atual do pacote.",
"example": "LG3LGGA3U8G28B4200NA"
},
"status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int64",
"description": "Código numérico referente ao estado do pacote.",
"example": 6
},
"highLevelStatus": {
"type": "string",
"description": "Status geral do pacote em formato legível.",
"example": "Com problema"
},
"description": {
"type": "string",
"description": "Breve descrição do status do pacote.",
"example": "Algo deu errado e o pacote está parado. O remetente precisa resolver o problema."
},
"actionRequired": {
"type": "object",
"properties": {
"reasonDescription": {
"type": "string",
"description": "Breve descrição da ação que precisa ser tomada pelo embarcador.",
"example": "Confira se está tudo certo com as informações do destinatário. Se tiver errado, corrija ou interrompa o envio."
},
"reasonLabel": {
"type": "string",
"description": "Rótulo da ação que precisa ser tomada pelo embarcador.",
"example": "Aguardando tratativa"
}
},
"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.",
"example": "RUA ANTONIO LEITE DE GOIS, S/N"
},
"city": {
"type": "string",
"description": "Cidade onde a agência dos Correios está localizada.",
"example": "Imaculada"
},
"state": {
"type": "string",
"description": "Unidade federativa (UF) onde a agência dos Correios está localizada.",
"example": "PB"
},
"postalCode": {
"type": "string",
"description": "CEP da agência dos Correios. No Brasil, usa-se o formato de 8 dígitos, sem hífen.",
"example": "58745971"
}
}
}
},
"description": "Objeto que representa as informações do status de um pacote."
},
"promisedDate": {
"type": "string",
"format": "date",
"description": "Estimativa de data para a primeira tentativa de entrega."
},
"trackingHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int64",
"description": "Código numérico referente ao estado do pacote.",
"example": 6
},
"highLevelStatus": {
"type": "string",
"description": "Status geral do pacote em formato legível.",
"example": "Com problema"
},
"description": {
"type": "string",
"description": "Breve descrição do status do pacote.",
"example": "Algo deu errado e o pacote está parado. O remetente precisa resolver o problema."
},
"actionRequired": {
"type": "object",
"properties": {
"reasonDescription": {
"type": "string",
"description": "Breve descrição da ação que precisa ser tomada pelo embarcador.",
"example": "Confira se está tudo certo com as informações do destinatário. Se tiver errado, corrija ou interrompa o envio."
},
"reasonLabel": {
"type": "string",
"description": "Rótulo da ação que precisa ser tomada pelo embarcador.",
"example": "Aguardando tratativa"
}
},
"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.",
"example": "RUA ANTONIO LEITE DE GOIS, S/N"
},
"city": {
"type": "string",
"description": "Cidade onde a agência dos Correios está localizada.",
"example": "Imaculada"
},
"state": {
"type": "string",
"description": "Unidade federativa (UF) onde a agência dos Correios está localizada.",
"example": "PB"
},
"postalCode": {
"type": "string",
"description": "CEP da agência dos Correios. No Brasil, usa-se o formato de 8 dígitos, sem hífen.",
"example": "58745971"
}
}
}
},
"description": "Objeto que representa as informações do status de um pacote."
},
"location": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "Cidade de onde a localização foi inferida para o status.",
"example": "São Paulo"
},
"state": {
"type": "string",
"description": "Estado (UF) de onde a localização foi inferida para o status.",
"example": "SP"
}
},
"description": "Objeto que representa a localização do pacote em um dado status."
}
}
},
"description": "Histórico de status de um pacote."
},
"location": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "Cidade de onde a localização foi inferida para o status.",
"example": "São Paulo"
},
"state": {
"type": "string",
"description": "Estado (UF) de onde a localização foi inferida para o status.",
"example": "SP"
}
},
"description": "Objeto que representa a localização do pacote em seu status atual."
},
"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.",
"example": "Maria das Dores"
},
"receiverDocument": {
"type": "string",
"description": "Número do documento identificador de quem recebeu o pacote no momento de sua entrega.",
"example": "123456789-01"
},
"locationDescription": {
"type": "string",
"description": "Descrição detalhada do local onde o pacote foi entregue.",
"example": "CONCIERGE"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"description": "Identificador interno para definir a informação fornecida a partir do arquivo.",
"example": "digital_signature"
},
"href": {
"type": "string",
"description": "URL com o arquivo referente à descrição da informação fornecida por quem recebeu.",
"example": "http://www.loggi.com"
}
}
}
}
}
},
"pickup_receipt": {
"type": "object",
"properties": {
"driver_name": {
"type": "string",
"description": "Nome da pessoa que fez a coleta.",
"example": "Leonardo Caprio"
},
"license_plate": {
"type": "string",
"description": "Placa do veículo de coleta.",
"example": "ABC4E67"
},
"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.",
"example": 1
}
}
},
"requestTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp do momento da requisição."
}
},
"description": "Objeto que representa os dados de rastreio de um pacote."
}
}
},
"description": "Objeto que retorna todos os pacotes que são identificados pelo CompanyID e TrackingCode passados na requisição."
},
"ErrorMessage": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "Código numérico referente à falha.\nCANCELLED = 1\nUNKNOWN = 2\nINVALID_ARGUMENT = 3\nDEADLINE_EXCEEDED = 4\nNOT_FOUND = 5\nALREADY_EXISTS = 6\nPERMISSION_DENIED = 7\nRESOURCE_EXHAUSTED = 8\nFAILED_PRECONDITION = 9\nABORTED = 10\nOUT_OF_RANGE = 11\nUNIMPLEMENTED = 12\nINTERNAL = 13\nUNAVAILABLE = 14\nDATA_LOSS = 15\nUNAUTHENTICATED = 16",
"example": 14
},
"message": {
"type": "string",
"description": "Texto pequeno informativo sobre a falha.",
"example": "Requisição com credenciais inválidas."
},
"details": {
"type": "array",
"description": "Detalhes sobre à falha. Nesta versão da API ainda não está sendo retornado, mas deve ser considerado um array de objetos de tipos distintos.",
"items": {},
"example": []
}
}
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
},
"_id": {
"buffer": {
"0": 106,
"1": 85,
"2": 76,
"3": 133,
"4": 81,
"5": 74,
"6": 83,
"7": 189,
"8": 15,
"9": 148,
"10": 170,
"11": 147
}
}
}
```