API Boxlink
  1. Outras operaçoes de pedidos
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)
          POST
        • Alterar o destinatário do Pedido
          PUT
        • Alterar os volumes do Pedido
          PUT
        • Inserir ocorrência no Pedido
          POST
      • 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
  • Rastreamento
    • Pesquisar ocorrências por e-mail
    • Pesquisar ocorrências das últimas 48 horas
    • Pesquisar ocorrências por Identificador do Pedido
    • Pesquisar ocorrências por Rastreadores TMS
    • Pesquisar ocorrência por Rastreador TMS
    • Pesquisar última ocorrência por Período
  • 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. Outras operaçoes de pedidos

Pesquisar um Pedido (Pré-envio)

Ambiente de Produção
https://api.boxlink.com.br
Ambiente de Produção
https://api.boxlink.com.br
POST
https://api.boxlink.com.br
/preenvio/consultar-periodo

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
clienteId
integer <int64>
optional
dataFinal
string <date>
optional
dataInicial
string <date>
optional
franquiaId
integer <int64>
optional
Example
{
    "clienteId": 0,
    "dataFinal": "2019-08-24",
    "dataInicial": "2019-08-24",
    "franquiaId": 0
}

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/preenvio/consultar-periodo' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clienteId": 0,
    "dataFinal": "2019-08-24",
    "dataInicial": "2019-08-24",
    "franquiaId": 0
}'

Responses

🟢200OK
application/json
Body
array of:
chaveSeller
string 
optional
dataEntregue
string <date-time>
optional
dataEnvio
string <date-time>
optional
dataNotaFiscal
string <date>
optional
dataPreenvio
string <date-time>
optional
dataPrevistaEntrega
string <date>
optional
dataSituacao
string <date-time>
optional
descricaoSituacao
string 
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
envioBloqueado
boolean 
optional
envioEstornado
boolean 
optional
envioExpedido
boolean 
optional
estrategiaDeFrete
string 
optional
nomeTransportadora
string 
optional
numeroNotaFiscal
string 
optional
observacao
string 
optional
pesoCubicoTotal
integer <int64>
optional
pesoTotal
integer <int64>
optional
preenvioAferido
boolean 
optional
preenvioCancelado
boolean 
optional
rastreadorTms
string 
optional
rastreadorTransportadora
string 
optional
sellerDocumento
string 
optional
sellerId
integer <int64>
optional
sellerNomeFantasia
string 
optional
sellerRazaoSocial
string 
optional
serieNotaFiscal
string 
optional
servicoTransportadora
string 
optional
tipoEnvio
string 
optional
valorCustoEstimado
number 
optional
valorCustoReal
number 
optional
valorDeclaradoParaSeguro
number 
optional
valorNotaFiscal
number 
optional
valorServico
number 
optional
volumes
integer <int64>
optional
Example
[
    {
        "chaveSeller": "string",
        "dataEntregue": "2019-08-24T14:15:22Z",
        "dataEnvio": "2019-08-24T14:15:22Z",
        "dataNotaFiscal": "2019-08-24",
        "dataPreenvio": "2019-08-24T14:15:22Z",
        "dataPrevistaEntrega": "2019-08-24",
        "dataSituacao": "2019-08-24T14:15:22Z",
        "descricaoSituacao": "string",
        "destinatarioBairro": "string",
        "destinatarioCep": "string",
        "destinatarioCidade": "string",
        "destinatarioComplemento": "string",
        "destinatarioDocumento": "string",
        "destinatarioEmail": "string",
        "destinatarioLogradouro": "string",
        "destinatarioNome": "string",
        "destinatarioNumero": "string",
        "destinatarioTelefone": "string",
        "destinatarioUf": "string",
        "envioBloqueado": true,
        "envioEstornado": true,
        "envioExpedido": true,
        "estrategiaDeFrete": "string",
        "nomeTransportadora": "string",
        "numeroNotaFiscal": "string",
        "observacao": "string",
        "pesoCubicoTotal": 0,
        "pesoTotal": 0,
        "preenvioAferido": true,
        "preenvioCancelado": true,
        "rastreadorTms": "string",
        "rastreadorTransportadora": "string",
        "sellerDocumento": "string",
        "sellerId": 0,
        "sellerNomeFantasia": "string",
        "sellerRazaoSocial": "string",
        "serieNotaFiscal": "string",
        "servicoTransportadora": "string",
        "tipoEnvio": "string",
        "valorCustoEstimado": 0,
        "valorCustoReal": 0,
        "valorDeclaradoParaSeguro": 0,
        "valorNotaFiscal": 0,
        "valorServico": 0,
        "volumes": 0
    }
]
🟢201Retorna um JSON com informações de preenvios gerados no periodo da consulta
🟠400Erro de validação
🟠401Você não tem permissão para acessar este recurso
🔴500Exceção não esperada
Modified at 2023-03-02 18:50:56
Previous
Fluxo do Pedido
Next
Alterar o destinatário do Pedido
Built with