API Boxlink

Inserir Envio para Tracking

Ambiente de Produção

https://api.boxlink.com.br

POST

/v2/envio-tracking/inserir

API do Canal Logístico | Envio

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

chaveSeller

string

optional

Chave do seller

Example:

223344

conteudo

array[object (EnvioTrackingConteudoRequest) {3}]

optional

JSON para informar os produtos contidos no envio

descricao

string

required

Descrição do produto enviada

Example:

CHARUTO CUBANO

quantidade

integer <int64>

required

Quantidade enviada do produto

Example:

valorUnitario

number

required

Valor Unitário do produto enviado

Example:

79.99

dataEnvio

string

required

Data do envio

Example:

2020-09-16

dataPrevistaParaEntrega

string

required

Data prevista para entrega

Example:

2020-09-16

destinatario

object (EnvioTrackingDestinatarioRequest)

required

JSON para informar o destinatário de um envio para tracking na plataforma Boxlink

bairro

string

required

Bairro do destinatário do envio

Example:

Centro

cep

string

required

CEP do destinatário do envio

Example:

63800-959

cidade

string

required

Cidade do destinatário do envio

Example:

Quixeramobim

complemento

string

optional

Complemento do endereço do destinatário do envio

Example:

Casa Verde

string

optional

E-mail do destinatário do envio

Example:

francisco@buarque.com

latitude

number

optional

Latitude do destinatário do envio

Example:

15.12345

logradouro

string

required

Logradouro do destinatário do envio

Example:

Rua do Anjo

longitude

number

optional

Longitude do destinatário do envio

Example:

95.12345

nome

string

required

Nome do destinatário do envio

Example:

Francisco Buarque

numero

string

required

Número do destinatário do envio

Example:

S/N

pontoReferencia

string

optional

Ponto de referência do endereço do destinatário do envio

Example:

Rua sem saída

telefone

string

optional

Telefone do destinatário do envio

Example:

(85) 1234-5678

string

required

UF do destinatário do envio

Example:

estrategiaFreteId

integer <int64>

required

ID da estratégia de frete utilizada no envio

Example:

identificacaoERP

string

optional

Informe a identificacao ERP para o preenvio

identificacaoEcommerce

string

optional

Informe a identificacao do Ecommerce para o preenvio

notaFiscal

object (EnvioTrackingNotaFiscalRequest)

optional

JSON para informar os dados da nota fiscal de um envio para tracking na plataforma Boxlink

chaveNfe

string

optional

Chave da Nota Fiscal Eletrônica

Example:

1.2345678901234568e+43

data

string

optional

Data da Nota Fiscal

Example:

2020-09-16

numero

string

optional

Número da Nota Fiscal

Example:

123456

serie

integer <int64>

optional

Série da Nota Fiscal

Example:

valor

number

optional

Valor da Nota Fiscal

Example:

799.99

rastreadorTransportadora

string

required

Código de rastreio da transportadora

Example:

OJ928383874BR

sellerId

integer <int64>

required

ID do seller na Boxlink

Example:

146

valorCobradoFrete

number

required

Valor do envio

Example:

5.12

valorCustoFrete

number

required

Valor do custo estimado do envio

Example:

5.12

Example

{
    "chaveSeller": 223344,
    "conteudo": [
        {
            "descricao": "CHARUTO CUBANO",
            "quantidade": 10,
            "valorUnitario": 79.99
        }
    ],
    "dataEnvio": "2020-09-16",
    "dataPrevistaParaEntrega": "2020-09-16",
    "destinatario": {
        "bairro": "Centro",
        "cep": "63800-959",
        "cidade": "Quixeramobim",
        "complemento": "Casa Verde",
        "email": "francisco@buarque.com",
        "latitude": 15.12345,
        "logradouro": "Rua do Anjo",
        "longitude": 95.12345,
        "nome": "Francisco Buarque",
        "numero": "S/N",
        "pontoReferencia": "Rua sem saída",
        "telefone": "(85) 1234-5678",
        "uf": "CE"
    },
    "estrategiaFreteId": 1,
    "identificacaoERP": "string",
    "identificacaoEcommerce": "string",
    "notaFiscal": {
        "chaveNfe": 1.2345678901234568e+43,
        "data": "2020-09-16",
        "numero": 123456,
        "serie": 1,
        "valor": 799.99
    },
    "rastreadorTransportadora": "OJ928383874BR",
    "sellerId": 146,
    "valorCobradoFrete": 5.12,
    "valorCustoFrete": 5.12
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.boxlink.com.br/v2/envio-tracking/inserir' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chaveSeller": 223344,
    "conteudo": [
        {
            "descricao": "CHARUTO CUBANO",
            "quantidade": 10,
            "valorUnitario": 79.99
        }
    ],
    "dataEnvio": "2020-09-16",
    "dataPrevistaParaEntrega": "2020-09-16",
    "destinatario": {
        "bairro": "Centro",
        "cep": "63800-959",
        "cidade": "Quixeramobim",
        "complemento": "Casa Verde",
        "email": "francisco@buarque.com",
        "latitude": 15.12345,
        "logradouro": "Rua do Anjo",
        "longitude": 95.12345,
        "nome": "Francisco Buarque",
        "numero": "S/N",
        "pontoReferencia": "Rua sem saída",
        "telefone": "(85) 1234-5678",
        "uf": "CE"
    },
    "estrategiaFreteId": 1,
    "identificacaoERP": "string",
    "identificacaoEcommerce": "string",
    "notaFiscal": {
        "chaveNfe": 1.2345678901234568e+43,
        "data": "2020-09-16",
        "numero": 123456,
        "serie": 1,
        "valor": 799.99
    },
    "rastreadorTransportadora": "OJ928383874BR",
    "sellerId": 146,
    "valorCobradoFrete": 5.12,
    "valorCustoFrete": 5.12
}'

Responses

🟢200OK

application/json

Body

data

object

optional

date

string

optional

exceptions

array[object (StandardException) {2}]

optional

string

optional

message

string

optional

resource

string

optional

success

boolean

optional

Example

{
    "data": {},
    "date": "string",
    "exceptions": [
        {
            "id": "string",
            "message": "string"
        }
    ],
    "resource": "string",
    "success": true
}

🟢201Retorna um JSON com o rastreador da plataforma boxlink no atributo data

🟠400Erro de validação

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

🔴500Exceção não esperada

Pesquisar Status do Ciclo de Vida do Pedido

Atualizar Envio para Tracking