API Boxlink
  1. Schemas
API Boxlink
  • Autenticação
    • Como autenticar ?
  • Cotação
    • Pesquisar cotação
    • Pesquisar cotação para múltiplos sellers
    • Pesquisar cotação simplificada
    • Pesquisar cotação simplificada para multiplos destinos
  • 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
  • Etiquetas
    • Imprimir etiqueta do Pedido (Pré-envio)
    • Imprimir etiqueta da Transportadora do Envio
  • 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
  • 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. Schemas

EnvioWebRequest(EnvioWebRequest)

JSON para inserir um envio no TMS Boxlink

{
    "adicionais": [
        "AR"
    ],
    "chaveCliente": "789875",
    "chaveNotaFiscal": "42200927288294000155550010000762021341196778",
    "conteudo": [
        {
            "descricao": "SANDALIA HAVAIANA",
            "linha": "CALCADOS",
            "quantidade": 10,
            "sku": "HAV33341BCA",
            "valorUnitario": 39.9
        }
    ],
    "dadosExtraNotaFiscal": {
        "dataEmissao": "string",
        "dataRecebimento": "string",
        "destinatarioIe": "string",
        "emitenteDocumento": "string",
        "emitenteIe": "string",
        "emitenteNome": "string",
        "protocolo": "string"
    },
    "dataNotaFiscal": "2022-01-31",
    "departamentoId": "null",
    "destinatario": {
        "aosCuidados": "SEU ZE",
        "bairro": "Consolação",
        "cep": "01302-000",
        "cidade": "São Paulo",
        "complemento": "Ladeira",
        "documento": "449.175.100-58",
        "email": "email@email.com.br",
        "empresa": "FIRMA",
        "inscricaoEstadual": "ISENTA",
        "latitude": 15.12345,
        "logradouro": "Rua da Consolação - até 1098 - lado par",
        "longitude": 95.12345,
        "nome": "JOSE DA SILVA",
        "numero": 123,
        "pontoReferencia": "null",
        "telefone": "(48) 99999-9999",
        "tipoDocumento": 1,
        "uf": "SP"
    },
    "estrategiaFreteId": 23,
    "identificacaoERP": "string",
    "identificacaoEcommerce": "string",
    "numeroNotaFiscal": "123456",
    "observacao": "Produto Frágil",
    "serieNotaFiscal": "2",
    "valorDeclaradoParaSeguro": 30,
    "valorNotaFiscal": 30,
    "volumes": [
        {
            "altura": 15,
            "comprimento": 30,
            "diametro": 50,
            "formato": "CAIXA",
            "largura": 20,
            "peso": 1500,
            "rastreadorVolumeSeller": "654321001"
        }
    ]
}
Built with