API Boxlink
  1. Rastreamento
API Boxlink
  • Autenticação
    • Como autenticar ?
  • Cotação
    • Pesquisar cotação
      POST
    • Pesquisar cotação para múltiplos sellers
      POST
    • Pesquisar cotação simplificada
      POST
    • Pesquisar cotação simplificada para multiplos destinos
      POST
  • Shipment
    • Pedido
      • Fluxo do Pedido
      • Outras operaçoes de pedidos
        • Pesquisar um Pedido (Pré-envio)
        • Alterar o destinatário do Pedido
        • Alterar os volumes do Pedido
        • Inserir ocorrência no Pedido
      • Inserir um Pedido
      • Atualizar dados de um Pedido
      • Aferir e Triar um Pedido
      • Aferir, Triar e Expedir um Pedido
      • Pesquisar Pedido pelo Identificador do Pedido
      • Pesquisar Status do Ciclo de Vida do Pedido
    • Envio somente para Tracking
      • Inserir Envio para Tracking
      • Atualizar Envio para Tracking
    • Envio
      • Fluxo do Envio
      • Inserir um Envio
    • Expedição
      • Listar Triagens (Abertas e Fechadas)
      • Expedir uma Triagem
      • Expedir uma Lista de Rastreadores
    • Ship from store
      • Chamar novamente a trasportadora da loja
    • Transportadoras
      • Entrega Própria
        • Adicionar ocorrência da entrega própria
        • Gerar lista de entregas próprias
        • Imprimir lista de entregas próprias
      • Alterar rastreador da transportadora
      • Imprimir Doc. de Expedição Por Rastreador TMS
      • Imprimir Doc. de Expedição Por ID
    • Cancelar um Pedido ou um Envio
      PUT
  • Etiquetas
    • Imprimir etiqueta do Pedido (Pré-envio)
      POST
    • Imprimir etiqueta da Transportadora do Envio
      POST
  • Logística Reversa
    • Inserir Solicitação de Logística Reversa
      POST
  • Rastreamento
    • Pesquisar ocorrências por e-mail
      GET
    • Pesquisar ocorrências das últimas 48 horas
      GET
    • Pesquisar ocorrências por Identificador do Pedido
      GET
    • Pesquisar ocorrências por Rastreadores TMS
      POST
    • Pesquisar ocorrência por Rastreador TMS
      GET
    • Pesquisar última ocorrência por Período
      GET
  • Cadastros
    • Sellers/Logistas
      • Departamentos
        • Cadastrar um Departamento do Seller
        • Alterar um Departamento do Seller
        • Desativar um Departamento do Seller
        • Ativar um Departamento do Seller
        • Pesquisar um Departamento do Seller
        • Pesquisar todos os Departamentos do Seller
      • Financeiro
        • Lançar um Valor na Fatura do Seller
        • Ajustar o Limite de Crédito do Seller
        • Pesquisar Limite de Crédito de um Seller
      • Cadastrar um Seller
      • Alterar um Seller
      • Desativar um Seller
      • Ativar um Seller
      • Pesquisar um Seller
      • Pesquisar todos os Sellers
    • Estratégias de Frete
      • Pesquisar estratégias de frete ativas do Canal
      • Pesquisar estratégias de frete disponíveis para o Seller
      • Alterar estratégias de frete de um Seller
  • Webhooks & Callback
    • Webhook para Atualização de Tracking na Plataforma Boxlink
    • Callback de Atualização de Status do Envio
  • Descontinuados
    • Cancelar um Pedido (Pré-envio) por ID
    • Cancelar uma etiqueta no TMS Boxlink
    • Cancelar uma etiqueta no TMS Boxlink
    • Editar os volumes de uma etiqueta no TMS Boxlink
    • Pesquisar envios da transportadora de uma determinada situação TMS Boxlink
    • Cadastrar um departamento do Seller *restrito aos tokens de Seller
    • Inserir uma etiqueta no TMS Boxlink
    • Atualizar dados de uma etiqueta reservada no TMS Boxlink
    • Ativar um departamento do Seller *restrito aos tokens de Seller
    • Pesquisar ocorrências de tracking de um envio atualizados até 48 horas após a data/hora informada
    • Desativar um departamento do Seller *restrito aos tokens de Seller
    • Buscar dados básicos de um departamento do Seller *restrito aos tokens de Seller
    • Editar o destinatário de uma etiqueta no TMS Boxlink
    • Atualizar um departamento do Seller *restrito aos tokens de Seller
    • Buscar todos os departamentos de um Seller do canal *restrito aos tokens de Seller
  1. Rastreamento

Pesquisar ocorrências por Identificador do Pedido

Ambiente de Produção
https://api.boxlink.com.br
Ambiente de Produção
https://api.boxlink.com.br
GET
https://api.boxlink.com.br
/v2/tracking/pedido/{numeroPedido}

Request

Path Params
numeroPedido
string 
required
Número do Pedido
Example:
123456
Header Params
Authorization
string 
required
Header para token JWT (utilize o prefixo Bearer ao inserir o token)

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.boxlink.com.br/v2/tracking/pedido/123456' \
--header 'Authorization;' \
--header 'Authorization;'

Responses

🟢200Retorna um JSON com os eventos de rastreio de um envio através do número do pedido
application/json
Body
array of:
rastreadorTms
string 
optional
eventos
array [object {29}] 
optional
altura
integer 
optional
comprimento
integer 
optional
dataEvento
string 
optional
descricao
string 
optional
destinoBairro
string 
optional
destinoCep
string 
optional
destinoCidade
string 
optional
destinoLocal
string 
optional
destinoLogradouro
string 
optional
destinoNumero
string 
optional
destinoUf
string 
optional
detalhe
string 
optional
diametro
integer 
optional
documento
string 
optional
formaEntrada
string 
optional
formato
string 
optional
largura
integer 
optional
origemCep
string 
optional
origemCidade
string 
optional
origemLocal
string 
optional
origemUf
string 
optional
peso
integer 
optional
pesoCubico
integer 
optional
rastreadorTms
string 
optional
rastreadorTransportadora
string 
optional
recebedor
string 
optional
situacaoId
integer 
optional
tipo
string 
optional
valorEnvio
integer 
optional
Example
[
    {
        "rastreadorTms": "BLK44000D7583",
        "eventos": [
            {
                "rastreadorTms": "BLK44000D7583",
                "rastreadorTransportadora": "AK097608145BR",
                "dataEvento": "2024-06-05T13:50:00",
                "situacaoId": 4,
                "tipo": "CORREIO",
                "formaEntrada": "ROBO",
                "descricao": "Objeto entregue ao destinatário",
                "detalhe": null,
                "recebedor": null,
                "documento": null,
                "origemLocal": "Unidade de Distribuição",
                "origemCep": null,
                "origemUf": "RJ",
                "origemCidade": "RIO DE JANEIRO",
                "destinoLocal": null,
                "destinoCep": null,
                "destinoBairro": null,
                "destinoCidade": null,
                "destinoUf": null,
                "destinoLogradouro": null,
                "destinoNumero": null,
                "documentoDestinatario": "123456789",
                "valorEnvio": 10.92,
                "peso": 1000,
                "pesoCubico": null,
                "formato": "CAIXA",
                "altura": 17,
                "largura": 21,
                "comprimento": 23,
                "diametro": null
            },
            {
                "rastreadorTms": "BLK44000D7583",
                "rastreadorTransportadora": "AK097608145BR",
                "dataEvento": "2024-06-04T15:57:00",
                "situacaoId": 2,
                "tipo": "CORREIO",
                "formaEntrada": "ROBO",
                "descricao": "Objeto postado",
                "detalhe": null,
                "recebedor": null,
                "documento": null,
                "origemLocal": "Agência dos Correios",
                "origemCep": null,
                "origemUf": "RJ",
                "origemCidade": "RIO DE JANEIRO",
                "destinoLocal": null,
                "destinoCep": null,
                "destinoBairro": null,
                "destinoCidade": null,
                "destinoUf": null,
                "destinoLogradouro": null,
                "destinoNumero": null,
                "documentoDestinatario": "123456789",
                "valorEnvio": 10.92,
                "peso": 1000,
                "pesoCubico": null,
                "formato": "CAIXA",
                "altura": 17,
                "largura": 21,
                "comprimento": 23,
                "diametro": null
            },
            {
                "rastreadorTms": "BLK44000D7583",
                "rastreadorTransportadora": null,
                "dataEvento": "2024-06-04T09:46:13.847",
                "situacaoId": 8,
                "tipo": "TMS",
                "formaEntrada": "FLUXO",
                "descricao": "Entregue para transportadora",
                "detalhe": null,
                "recebedor": null,
                "documento": null,
                "origemLocal": null,
                "origemCep": "23123-123",
                "origemUf": "RJ",
                "origemCidade": "RIO DE JANEIRO",
                "destinoLocal": null,
                "destinoCep": null,
                "destinoBairro": null,
                "destinoCidade": null,
                "destinoUf": null,
                "destinoLogradouro": null,
                "destinoNumero": null,
                "documentoDestinatario": "123456789",
                "valorEnvio": 10.92,
                "peso": 1000,
                "pesoCubico": null,
                "formato": "CAIXA",
                "altura": 17,
                "largura": 21,
                "comprimento": 23,
                "diametro": null
            },
            {
                "rastreadorTms": "BLK44000D7583",
                "rastreadorTransportadora": null,
                "dataEvento": "2024-06-04T09:45:28.034",
                "situacaoId": 9,
                "tipo": "TMS",
                "formaEntrada": "FLUXO",
                "descricao": "Pedido faturado",
                "detalhe": null,
                "recebedor": null,
                "documento": null,
                "origemLocal": "MEU ECOMMERCE",
                "origemCep": "23123-123",
                "origemUf": "RJ",
                "origemCidade": "RIO DE JANEIRO",
                "destinoLocal": null,
                "destinoCep": null,
                "destinoBairro": null,
                "destinoCidade": null,
                "destinoUf": null,
                "destinoLogradouro": null,
                "destinoNumero": null,
                "documentoDestinatario": "123456789",
                "valorEnvio": 10.92,
                "peso": 1000,
                "pesoCubico": null,
                "formato": "CAIXA",
                "altura": 17,
                "largura": 21,
                "comprimento": 23,
                "diametro": null
            }
        ]
    },
    {
        "rastreadorTms": "BLK09000D7585",
        "eventos": [
            {
                "rastreadorTms": "BLK09000D7585",
                "rastreadorTransportadora": "AK097608009BR",
                "dataEvento": "2024-06-05T14:33:00",
                "situacaoId": 4,
                "tipo": "CORREIO",
                "formaEntrada": "ROBO",
                "descricao": "Objeto entregue ao destinatário",
                "detalhe": null,
                "recebedor": null,
                "documento": null,
                "origemLocal": "Unidade de Distribuição",
                "origemCep": null,
                "origemUf": "RJ",
                "origemCidade": "RIO DE JANEIRO",
                "destinoLocal": null,
                "destinoCep": null,
                "destinoBairro": null,
                "destinoCidade": null,
                "destinoUf": null,
                "destinoLogradouro": null,
                "destinoNumero": null,
                "documentoDestinatario": "03813590771",
                "valorEnvio": 10.92,
                "peso": 1000,
                "pesoCubico": null,
                "formato": "CAIXA",
                "altura": 17,
                "largura": 21,
                "comprimento": 23,
                "diametro": null
            },
            {
                "rastreadorTms": "BLK09000D7585",
                "rastreadorTransportadora": "AK097608009BR",
                "dataEvento": "2024-06-04T15:57:00",
                "situacaoId": 2,
                "tipo": "CORREIO",
                "formaEntrada": "ROBO",
                "descricao": "Objeto postado",
                "detalhe": null,
                "recebedor": null,
                "documento": null,
                "origemLocal": "Agência dos Correios",
                "origemCep": null,
                "origemUf": "RJ",
                "origemCidade": "RIO DE JANEIRO",
                "destinoLocal": null,
                "destinoCep": null,
                "destinoBairro": null,
                "destinoCidade": null,
                "destinoUf": null,
                "destinoLogradouro": null,
                "destinoNumero": null,
                "documentoDestinatario": "03813590771",
                "valorEnvio": 10.92,
                "peso": 1000,
                "pesoCubico": null,
                "formato": "CAIXA",
                "altura": 17,
                "largura": 21,
                "comprimento": 23,
                "diametro": null
            },
            {
                "rastreadorTms": "BLK09000D7585",
                "rastreadorTransportadora": null,
                "dataEvento": "2024-06-04T09:46:14.928",
                "situacaoId": 8,
                "tipo": "TMS",
                "formaEntrada": "FLUXO",
                "descricao": "Entregue para transportadora",
                "detalhe": null,
                "recebedor": null,
                "documento": null,
                "origemLocal": null,
                "origemCep": "23123-123",
                "origemUf": "RJ",
                "origemCidade": "RIO DE JANEIRO",
                "destinoLocal": null,
                "destinoCep": null,
                "destinoBairro": null,
                "destinoCidade": null,
                "destinoUf": null,
                "destinoLogradouro": null,
                "destinoNumero": null,
                "documentoDestinatario": "03813590771",
                "valorEnvio": 10.92,
                "peso": 1000,
                "pesoCubico": null,
                "formato": "CAIXA",
                "altura": 17,
                "largura": 21,
                "comprimento": 23,
                "diametro": null
            },
            {
                "rastreadorTms": "BLK09000D7585",
                "rastreadorTransportadora": null,
                "dataEvento": "2024-06-04T09:45:28.902",
                "situacaoId": 9,
                "tipo": "TMS",
                "formaEntrada": "FLUXO",
                "descricao": "Pedido faturado",
                "detalhe": null,
                "recebedor": null,
                "documento": null,
                "origemLocal": "MEU ECOMMERCE",
                "origemCep": "23123-123",
                "origemUf": "RJ",
                "origemCidade": "RIO DE JANEIRO",
                "destinoLocal": null,
                "destinoCep": null,
                "destinoBairro": null,
                "destinoCidade": null,
                "destinoUf": null,
                "destinoLogradouro": null,
                "destinoNumero": null,
                "documentoDestinatario": "03813590771",
                "valorEnvio": 10.92,
                "peso": 1000,
                "pesoCubico": null,
                "formato": "CAIXA",
                "altura": 17,
                "largura": 21,
                "comprimento": 23,
                "diametro": null
            }
        ]
    }
]
🟠401Você não tem permissão para acessar este recurso
🟠403Forbidden!
🟠404Não encontrado
🔴500Exceção não esperada
Modified at 2024-09-10 00:40:00
Previous
Pesquisar ocorrências das últimas 48 horas
Next
Pesquisar ocorrências por Rastreadores TMS
Built with