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 Rastreadores TMS

Ambiente de Produção
https://api.boxlink.com.br
Ambiente de Produção
https://api.boxlink.com.br
POST
https://api.boxlink.com.br
/v2/tracking

Request

Header Params
Authorization
string 
required
Header para token JWT (utilize o prefixo Bearer ao inserir o token)
Body Params application/json
JSON de pedido para Rastreamento
rastreadores
array[string]
optional
Lista de Rastreadores no sistema Boxlink
Example
{
    "rastreadores": [
        "string"
    ]
}

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 POST 'https://api.boxlink.com.br/v2/tracking' \
--header 'Authorization;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rastreadores": [
        "string"
    ]
}'

Responses

🟢200Retorna um JSON com os eventos de envio do código de rastreio do TMS Boxlink
application/json
Body
array of:
eventos
array[object (RastreadorEventoResponse) {28}] 
optional
Eventos
altura
integer <int64>
optional
Altura
comprimento
integer <int64>
optional
Comprimento
dataEvento
string <date-time>
optional
Data do Evento
descricao
string 
optional
Descrição do Evento
destinoBairro
string 
optional
Bairro de Destino do Envio
destinoCep
string 
optional
Cep de Destino do Envio
destinoCidade
string 
optional
Cidade de Destino do Envio
destinoLocal
string 
optional
Local de Destino do Envio
destinoLogradouro
string 
optional
Logradouro de Destino do Envio
destinoNumero
string 
optional
Número de Destino do Envio
destinoUf
string 
optional
UF de Destino do Envio
detalhe
string 
optional
Detalhes do Evento
diametro
integer <int64>
optional
Diâmetro
documento
string 
optional
Documento do Recebedor do Envio
formaEntrada
enum<string> 
optional
Forma de Entrada do Evento
Allowed values:
ROBOMANUALFLUXOWEBHOOK
formato
enum<string> 
optional
Formato
Allowed values:
ENVELOPECILINDROCAIXAMALA
largura
integer <int64>
optional
Largura
origemCep
string 
optional
Cep de Origem do Envio
origemCidade
string 
optional
Cidade de Origem do Envio
origemLocal
string 
optional
Local de Origem do Envio
origemUf
string 
optional
UF de Origem do Envio
peso
integer <int64>
optional
Peso
pesoCubico
integer <int64>
optional
Peso Cúbico
rastreadorTms
string 
optional
Código de Rastreio do TMS Boxlink
recebedor
string 
optional
Recebedor do Envio
situacaoId
integer <int64>
optional
ID da Situação do Evento
tipo
string 
optional
Tipo do Evento
valorEnvio
number 
optional
Valor do Envio
rastreadorTms
string 
optional
Código de Rastreio do TMS Boxlink
Example
[
    {
        "eventos": [
            {
                "altura": 0,
                "comprimento": 0,
                "dataEvento": "2019-08-24T14:15:22Z",
                "descricao": "string",
                "destinoBairro": "string",
                "destinoCep": "string",
                "destinoCidade": "string",
                "destinoLocal": "string",
                "destinoLogradouro": "string",
                "destinoNumero": "string",
                "destinoUf": "string",
                "detalhe": "string",
                "diametro": 0,
                "documento": "string",
                "formaEntrada": "ROBO",
                "formato": "ENVELOPE",
                "largura": 0,
                "origemCep": "string",
                "origemCidade": "string",
                "origemLocal": "string",
                "origemUf": "string",
                "peso": 0,
                "pesoCubico": 0,
                "rastreadorTms": "string",
                "recebedor": "string",
                "situacaoId": 0,
                "tipo": "string",
                "valorEnvio": 0
            }
        ],
        "rastreadorTms": "string"
    }
]
🟠400Erro de validação
🟠401Você não tem permissão para acessar este recurso
🟠404Não encontrado
🔴500Exceção não esperada
Modified at 2023-03-02 18:31:59
Previous
Pesquisar ocorrências por Identificador do Pedido
Next
Pesquisar ocorrência por Rastreador TMS
Built with