Inserir um Envio - API Boxlink

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

chaveNotaFiscal

string

optional

Chave da Nota Fiscal do Objeto

numeroNotaFiscal

string

optional

Número da Nota Fiscal do Objeto

serieNotaFiscal

string

optional

Série da Nota Fiscal do Objeto

dataNotaFiscal

string <date>

optional

Data da Nota Fiscal do Objeto

valorNotaFiscal

number

optional

Valor da Nota Fiscal do Objeto

valorDeclarado

number

optional

Valor Declarado para Seguro

dadosExtraNotaFiscal

object (PrePostagemMiniDanfeRequest)

optional

Dados opcionais da NF-e, utilizados para impressão de Mini DANFE

dataEmissao

string

optional

Data de Emissão da Nota Fiscal

dataRecebimento

string

optional

Data do Recebimento da Nota Fiscal

destinatarioIe

string

optional

Inscrição Estadual do Destinatário

emitenteDocumento

string

optional

CNPJ ou CPF do Emitente

emitenteIe

string

optional

Inscrição Estadual do Emitente

emitenteNome

string

optional

Nome do Emitente da Nota Fiscal

protocolo

string

optional

Protocolo da Nota Fiscal Eletrônica

destinatario

object

required

Dados do destinatário do envio

nome

string

required

Nome do Destinatário

ignorarValidacaoDeCep

boolean

optional

Marcar true caso não seja necessario validar o cep

cep

string

required

CEP do Destinatário

logradouro

string

required

Logradouro do Destinatário

numero

string

required

Número do Endereço do Destinatário

complemento

string

optional

Complemento do Endereço do Destinatário

pontoReferencia

string

optional

Ponto de Referência do Endereço do Destinatário

bairro

string

required

Bairro do Destinatário

cidade

string

required

Cidade do Destinatário

uf

string

required

UF do Destinatário

latitude

number

optional

Latitude do Endereço do Destinatário

Example:

15.12345

longitude

number

optional

Longitude do Endereço do Destinatário

Example:

95.12345

tipoDocumento

integer <int32>

required

Tipo de Documento (1-CPF ou 2-CNPJ)

documento

string

required

Número do Documento (CPF ou CNPJ)

inscricaoEstadual

string

optional

Inscrição Estadual do Destinatário

email

string

required

E-mail do Destinatário

telefone

string

required

Telefone do Destinatário

inserirOcorrencia

boolean

optional

Informe false caso não queira que seja criada uma ocorrencia. O padrão é true.

descricaoOcorrencia

string

optional

Informe a descriação da Ocorrência (somente quando inserirOcorrencia : true) . O padrão é Preparando Envio.

volumes

array [object {6}]

required

JSON com os volumes do envio. Caso não seja informado, será considerado 1 volume

peso

string

required

Peso do Volume (gramas)

formato

enum<string>

required

Formato do Volume e caso de duvida use sempra CAIXA

Allowed values:

ENVELOPECILINDROCAIXA

altura

number <double>

optional

Altura do Volume (cm)

largura

number <double>

optional

Largura do Volume (cm)

comprimento

number <double>

optional

Comprimento do Volume (cm)

diametro

number <double>

optional

Diâmetro do Volume quando Cilindro (cm)

identificadorPedido

string

required

Identificador do pedido na loja ou e-commerce

identificadorERP

string

optional

Informe a identificacao ERP para o preenvio

identificadorEcommerce

string

optional

Informe a identificacao do Ecommerce para o preenvio

observacao

string

optional

Campo livre para inserir observações

conteudo

array [object {6}]

optional

Declaração de Conteúdo do Envio. Geralmente são os itens da Nota Fiscal

descricao

string

required

Descrição do Conteúdo

sku

string

optional

SKU - Unidade de Manutenção de Estoque

linha

string

optional

Descrição da Linha de Produto

quantidade

integer <int64>

required

Quantidade do Conteúdo

valorUnitario

number

required

Valor Unitário do Conteúdo

valorTotal

number

required

Valor Total do Conteúdo

dataCriacaoPedidoLoja

string

optional

Data da criação do pedido na loja ou e e-commerce

dataEstimadaEntrega

string <date>

optional

Data Estimada de Entrega no momento da cotação ou fechamento do pedido na loja

Example:

2012-07-04

valorServicoEstimado

number

optional

Valor do frete na Cotação ou no Fechamento do Pedido.

cotacaoId

string

required

Cotação ID recebido durante o processo de cotação

sellerId

integer

optional

Id do seller na Boxlink [obrigatório quando for utilizado um token do canal]

Example

{
  "numeroNotaFiscal": "26998",
  "serieNotaFiscal": "1",
  "chaveNotaFiscal": "42221024692452000140550010002699981592665764",
  "dataNotaFiscal": "2023-08-01",
  "valorNotaFiscal": 190.12,
  "valorDeclarado": 190.12,
  "identificadorPedido": "xyz-1234",
  "identificadorERP": "xyz-1123",
  "identificadorEcommerce": "xyz-1255",
  "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"
  },
  "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"
    }
  ],
  "volumes": [
    {
      "formato": "CAIXA",
      "peso": 198,
      "altura": 15,
      "largura": 15,
      "comprimento": 15,
      "diametro": 0
    }
  ],
  "cotacaoId": "782987d0-318b-4d9f-99bf-7bae9d9481cd"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.boxlink.com.br/inserir-envio' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "numeroNotaFiscal": "26998",
  "serieNotaFiscal": "1",
  "chaveNotaFiscal": "42221024692452000140550010002699981592665764",
  "dataNotaFiscal": "2023-08-01",
  "valorNotaFiscal": 190.12,
  "valorDeclarado": 190.12,
  "identificadorPedido": "xyz-1234",
  "identificadorERP": "xyz-1123",
  "identificadorEcommerce": "xyz-1255",
  "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"
  },
  "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"
    }
  ],
  "volumes": [
    {
      "formato": "CAIXA",
      "peso": 198,
      "altura": 15,
      "largura": 15,
      "comprimento": 15,
      "diametro": 0
    }
  ],
  "cotacaoId": "782987d0-318b-4d9f-99bf-7bae9d9481cd"
}'

Responses

🟢201OK

application/json

Body

id

integer

required

rastreadorTms

string

required

rastreadorLastMile

string

required

dataCriacao

string

required

horaCriacao

string

required

envioSomenteParaTracking

boolean

required

Example

{
  "id": 463,
  "rastreadorTms": "SC4C600000179",
  "rastreadorLastMile": "12536600090501",
  "dataCriacao": "2024-07-09",
  "horaCriacao": "14:21:18.21817996",
  "envioSomenteParaTracking": false
}

🟠400Erro de validação

🟠401Você não tem permissão para acessar este recurso

🔴500Exceção não esperada