API Boxlink
  1. Autenticação
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
  • Schemas
    • Schemas
      • ApiRastreadorEventoDTO
      • ClienteDepartamentoIntegracaoRequest
      • CotacaoAgrupadaRequest
      • CotacaoMultiSellerPrecoPrazoApiRequest
      • CotacaoPorDemandaDTO
      • CotacaoPrecoPrazoApiRequest
      • DepartamentoSellerApiRequest
      • DepartamentoSellerApiResponse
      • EnderecoApiRequest
      • EnderecoApiResponse
      • EnvioAferidoDescritivoResponse
      • EnvioAferidoResponse
      • EnvioConteudoWebRequest
      • EnvioDestinatarioResponse
      • EnvioDestinatarioWebRequest
      • EnvioMiniDanfeWebRequest
      • EnvioSituacaoResponse
      • EnvioTrackingConteudoRequest
      • EnvioTrackingDestinatarioRequest
      • EnvioTrackingNotaFiscalRequest
      • EnvioTrackingRequest
      • EnvioVolumeWebRequest
      • EnvioWebRequest
      • EstrategiaFreteSellerApiRequest
      • EstrategiaFreteSellerApiResponse
      • ExcecaoTextual
      • LogisticaReversaRequest
      • InserirOcorrenciaRequest
      • LocalTime
      • LogisticaReversaConteudoRequest
      • LogisticaReversaNotaFiscalRequest
      • LogisticaReversaVolumeRequest
      • PedidoDeAfericaoDTO
      • PedidoDeRastreamentoApiRequest
      • PesquisaPreenvioApiResponse
      • PesquisaPreenvioPeriodoFilterRequest
      • PrePostagemApiAdicionalRequest
      • PrePostagemApiConteudoRequest
      • PrePostagemApiDestinatarioRequest
      • PrePostagemCancelarRequest
      • PrePostagemDestinatarioReenvioRequest
      • PrePostagemIntegracaoRequest
      • PrePostagemIntegracaoResponse
      • PrePostagemMiniDanfeRequest
      • PrePostagemVolumeRequest
      • PrecoPrazoMultiSellerResponse
      • PrecoPrazoResponse
      • PreenvioApiResponse
      • PreenvioVolumeApiResponse
      • RastreadorEventoAgrupadosResponse
      • RastreadorEventoResponse
      • RastreadorPostagemResponseDTO
      • ReservaEtiquetaRequest
      • SellerApiRequest
      • SellerApiResponse
      • SituacaoAtualizacaoRequest
      • StandardApiResponse
      • StandardException
      • TrackingOccurrencePageResponse
      • TriagemResponse
      • UltimaOcorrenciaDoEnvioApiResponse
      • VolumeParaAfericaoDTO
      • VolumesRequest
      • CotacaoSimplificada
      • CotacaoSimplificdaResponse200
    • RequestBodies
  1. Autenticação

Como autenticar ?

Bearer Token#

O Bearer Token é um recurso utilizado para garantir a segurança durante a utilização da API.
Ele será solicitado durante seu uso da API, afim de garantir a autenticidade das requisições e evitar conflitos.
É possível obter o token nas configurações pelo acesso do módulo de matriz da Boxlink como apresentado na imagem abaixo.
Captura de tela 2023-06-16 120510.png

Como fazer autenticação?#

Autenticação na api da Boxlink é feita passando o Bearer Token gerado no parametro Authorization no Header da requisição.
image.png
TIP
Ao inserir o token no Header da requisição da API não esqueça de adicionar o prefixo Bearer ao token
Modified at 2023-06-16 15:20:53
Next
Pesquisar cotação
Built with