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

Pesquisar Pedido pelo Identificador do Pedido

Ambiente de Produção
Ambiente de Produção
GET
https://api.boxlink.com.br/v2/pre-envio/consultar/{identificadorPedido}

Request

Path Params
identificadorPedido
string 
required
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}

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/pre-envio/consultar/' \
--header 'Authorization;'

Responses

🟢200OK
application/json
Body
array of:
dataCriacao
string <date-time>
optional
dataNotaFiscal
string <date>
optional
destinatarioBairro
string 
optional
destinatarioCep
string 
optional
destinatarioCidade
string 
optional
destinatarioComplemento
string 
optional
destinatarioDocumento
string 
optional
destinatarioEmail
string 
optional
destinatarioLogradouro
string 
optional
destinatarioNome
string 
optional
destinatarioNumero
string 
optional
destinatarioTelefone
string 
optional
destinatarioUf
string 
optional
estrategiaDeFrete
string 
optional
numeroNotaFiscal
string 
optional
numeroPedido
string 
optional
observacao
string 
optional
preenvioAferido
boolean 
optional
preenvioCancelado
boolean 
optional
rastreadorTms
string 
optional
sellerDocumento
string 
optional
sellerId
integer <int64>
optional
sellerNomeFantasia
string 
optional
sellerRazaoSocial
string 
optional
serieNotaFiscal
string 
optional
valorDeclaradoParaSeguro
number 
optional
valorNotaFiscal
number 
optional
volumes
array[object (PreenvioVolumeApiResponse) {7}] 
optional
altura
integer <int64>
optional
comprimento
integer <int64>
optional
diametro
integer <int64>
optional
formato
string 
optional
largura
integer <int64>
optional
peso
integer <int64>
optional
tagVolume
string 
optional
Example
[
  {
    "dataCriacao": "2019-08-24T14:15:22Z",
    "dataNotaFiscal": "2019-08-24",
    "destinatarioBairro": "string",
    "destinatarioCep": "string",
    "destinatarioCidade": "string",
    "destinatarioComplemento": "string",
    "destinatarioDocumento": "string",
    "destinatarioEmail": "string",
    "destinatarioLogradouro": "string",
    "destinatarioNome": "string",
    "destinatarioNumero": "string",
    "destinatarioTelefone": "string",
    "destinatarioUf": "string",
    "estrategiaDeFrete": "string",
    "numeroNotaFiscal": "string",
    "numeroPedido": "string",
    "observacao": "string",
    "preenvioAferido": true,
    "preenvioCancelado": true,
    "rastreadorTms": "string",
    "sellerDocumento": "string",
    "sellerId": 0,
    "sellerNomeFantasia": "string",
    "sellerRazaoSocial": "string",
    "serieNotaFiscal": "string",
    "valorDeclaradoParaSeguro": 0,
    "valorNotaFiscal": 0,
    "volumes": [
      {
        "altura": 0,
        "comprimento": 0,
        "diametro": 0,
        "formato": "string",
        "largura": 0,
        "peso": 0,
        "tagVolume": "string"
      }
    ]
  }
]
🟢201Retorna um JSON com informações de preenvios com o numero do pedido
🟠400Erro de validação
🟠401Você não tem permissão para acessar este recurso
🟠403Forbidden!
🔴500Exceção não esperada
Modified at 2024-04-22 17:30:38
Previous
Aferir, Triar e Expedir um Pedido
Next
Pesquisar Status do Ciclo de Vida do Pedido
Built with