API Boxlink
  1. Shipment
  2. Pedido
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
        POST
      • Atualizar dados de um Pedido
        PUT
      • Aferir e Triar um Pedido
        POST
      • Aferir, Triar e Expedir um Pedido
        POST
      • Pesquisar Pedido pelo Identificador do Pedido
        GET
      • Pesquisar Status do Ciclo de Vida do Pedido
        GET
    • 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. Shipment
  2. Pedido

Aferir e Triar um Pedido

Ambiente de Produção
Ambiente de Produção
POST
https://api.boxlink.com.br/envio/aferir-triar
API do Canal Logístico | Operacional

Request

Header Params
Authorization
string 
required
Token da Boxlink para utilização da API. (Utilize o prefixo Bearer ao inserir o token)
Default:
Bearer {seu_token_aqui}
Body Params application/json
rastreadorTms
string 
required
Rastreador da Boxlink do envio a ser aferido e triado.
urlImagem
string 
optional
Opcional caso possua uma imagem do pacote para incorporar na página de rastreio deve ser informada a URL aqui
volumes
array [object {7}] 
required
peso
integer <int64>
required
O peso deve ser informado em gramas
formato
enum<string> 
required
O formato deve ser CAIXA, ENVELOPE ou CILINDRO
Allowed values:
ENVELOPECILINDROCAIXA
altura
integer <int64>
required
Obrigatório somente para o formato CAIXA em centímetros
largura
integer <int64>
required
Obrigatório somente para o formato CAIXA e ENVELOPE em centímetros
comprimento
integer <int64>
required
Obrigatório somente para o formato CAIXA, ENVELOPE e CILINDRO em centímetros
diametro
integer <int64>
required
Obrigatório somente para o formato CILINDRO em centímetros
identificadorDoVolume
string 
optional
Obrigatório nos casos de existir mais de um volume no pedido
Example
{
  "rastreadorTms": "PRO9F00000018",
  "urlImagem": "https://img-repo/uploads/abcd.jpg",
  "volumes": [
    {
      "peso": 826,
      "formato": "CAIXA",
      "altura": 28,
      "largura": 33,
      "comprimento": 29,
      "diametro": 0,
      "identificadorDoVolume": "_01"
    }
  ]
}

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/envio/aferir-triar' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rastreadorTms": "PRO9F00000018",
    "urlImagem": "https://img-repo/uploads/abcd.jpg",
    "volumes": [
        {
            "peso": 826,
            "formato": "CAIXA",
            "altura": 28,
            "largura": 33,
            "comprimento": 29,
            "diametro": 0,
            "identificadorDoVolume": "_01"
        }
    ]
}'

Responses

🟢200OK
application/json
Body
envio
object (EnvioAferidoDescritivoResponse) 
optional
cep
string 
optional
descricaoTrechos
string 
optional
estrategiaFreteNome
string 
optional
id
integer <int64>
optional
peso
integer <int64>
optional
rastreadorTms
string 
optional
valorComercial
number 
optional
valorCustoEstimado
number 
optional
excecoes
array[object (ExcecaoTextual) {1}] 
optional
excecao
string 
optional
mensagemDeRetorno
string 
optional
status
enum<string> 
optional
Allowed values:
SUCESSOSUCESSO_COM_AVISOERRO_TEMPORARIOERRO_PROCESSAMENTOACAO_INVALIDA
Example
{
  "envio": {
    "cep": "string",
    "descricaoTrechos": "string",
    "estrategiaFreteNome": "string",
    "id": 0,
    "peso": 0,
    "rastreadorTms": "string",
    "valorComercial": 0,
    "valorCustoEstimado": 0
  },
  "excecoes": [
    {
      "excecao": "string"
    }
  ],
  "mensagemDeRetorno": "string",
  "status": "SUCESSO"
}
🟢201Retorna um JSON com informações do envio aferido e triado
🟠400Erro de validação
🟠401Você não tem permissão para acessar este recurso
🔴500Exceção não esperada
Modified at 2024-05-20 17:05:13
Previous
Atualizar dados de um Pedido
Next
Aferir, Triar e Expedir um Pedido
Built with