API Boxlink
  1. 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. Pedido

Inserir um Pedido

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/pre-envio

Request

Header Params

Body Params application/json

Example
{
  "destinatario": {
    "nome": "BOXLINK LTDA",
    "aosCuidados": "",
    "logradouro": "AV EVANDRO BATISTA VIEIRA",
    "numero": "165",
    "complemento": "",
    "bairro": "ALPHAVILLE",
    "cidade": "Campinas",
    "uf": "SP",
    "cep": "13098390",
    "ignorarValidacaoDeCep": true,
    "telefone": "1937370020",
    "email": "franciele@exemplo.com.br",
    "tipoDocumento": 2,
    "documento": "02837536000191"
  },
  "valorDeclarado": 190.12,
  "numeroNotaFiscal": "26998",
  "serieNotaFiscal": "1",
  "chaveNotaFiscal": "42221024692452000140550010002699981592665764",
  "valorNotaFiscal": 190.12,
  "dataNotaFiscal": "2023-08-01",
  "identificadorPedido": "xyz-123_",
  "estrategiaFreteNome": "MAIS RAPIDO",
  "adicionais": [],
  "conteudo": [
    {
      "descricao": "Batom Safe Red",
      "quantidade": 8,
      "valorUnitario": 12.46,
      "valorTotal": 99.68,
      "sku": "0763331002265"
    },
    {
      "descricao": "Batom Safe Kiss",
      "quantidade": 4,
      "valorUnitario": 12.46,
      "valorTotal": 49.84,
      "sku": "0788115653099"
    },
    {
      "descricao": "Balm de Olhos",
      "quantidade": 2,
      "valorUnitario": 20.3,
      "valorTotal": 40.6,
      "sku": "0751320183620"
    }
  ],
  "volumes": [
    {
      "formato": "CAIXA",
      "peso": 198,
      "altura": 15,
      "largura": 15,
      "comprimento": 15,
      "diametro": 0,
      "identificadorDoVolume": "_01"
    }
  ],
  "inserirOcorrencia": true
}

Request Code 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/pre-envio' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "destinatario": {
    "nome": "BOXLINK LTDA",
    "aosCuidados": "",
    "logradouro": "AV EVANDRO BATISTA VIEIRA",
    "numero": "165",
    "complemento": "",
    "bairro": "ALPHAVILLE",
    "cidade": "Campinas",
    "uf": "SP",
    "cep": "13098390",
    "ignorarValidacaoDeCep": true,
    "telefone": "1937370020",
    "email": "franciele@exemplo.com.br",
    "tipoDocumento": 2,
    "documento": "02837536000191"
  },
  "valorDeclarado": 190.12,
  "numeroNotaFiscal": "26998",
  "serieNotaFiscal": "1",
  "chaveNotaFiscal": "42221024692452000140550010002699981592665764",
  "valorNotaFiscal": 190.12,
  "dataNotaFiscal": "2023-08-01",
  "identificadorPedido": "xyz-123_",
  "estrategiaFreteNome": "MAIS RAPIDO",
  "adicionais": [],
  "conteudo": [
    {
      "descricao": "Batom Safe Red",
      "quantidade": 8,
      "valorUnitario": 12.46,
      "valorTotal": 99.68,
      "sku": "0763331002265"
    },
    {
      "descricao": "Batom Safe Kiss",
      "quantidade": 4,
      "valorUnitario": 12.46,
      "valorTotal": 49.84,
      "sku": "0788115653099"
    },
    {
      "descricao": "Balm de Olhos",
      "quantidade": 2,
      "valorUnitario": 20.3,
      "valorTotal": 40.6,
      "sku": "0751320183620"
    }
  ],
  "volumes": [
    {
      "formato": "CAIXA",
      "peso": 198,
      "altura": 15,
      "largura": 15,
      "comprimento": 15,
      "diametro": 0,
      "identificadorDoVolume": "_01"
    }
  ],
  "inserirOcorrencia": true
}'

Responses

🟢200OK
application/json
Body

Example
{
    "dataCriacao": "2019-08-24",
    "horaCriacao": {
        "hour": 0,
        "minute": 0,
        "nano": 0,
        "second": 0
    },
    "id": 0,
    "rastreadorTms": "string"
}
🟢201OK
🟠400Erro de validação
🟠401Você não tem permissão para acessar este recurso
🔴500Exceção não esperada
Modified at 2024-02-06 14:56:39
Previous
Inserir ocorrência no Pedido
Next
Atualizar dados de um Pedido
Built with