Atualizar dados de uma etiqueta reservada no TMS Boxlink

Request

Path Params

rastreadorTms

string

required

rastreadorTms

Header Params

Authorization

string

required

Header para token JWT (utilize o prefixo Bearer ao inserir o token)

Body Params application/json

JSON para inserir uma etiqueta no TMS Boxlink

adicionais

array[object (PrePostagemApiAdicionalRequest) {1}]

optional

Lista de Adicionais selecionados para o Envio

siglaAdicional

enum<string>

optional

Sigla do Adicional

Allowed values:

ARMPVDICGFEMJDCD

chaveCliente

string

optional

Chave do Cliente (utilizado geralmente para inserir o número do pedido)

chaveNotaFiscal

string

optional

Chave da Nota Fiscal do Objeto

clienteDepto

object (ClienteDepartamentoIntegracaoRequest)

optional

JSON para informar o Departamento de uma etiqueta no TMS Boxlink

codReferencia

string

optional

Código de Referência do Departamento que está efetuando o Envio

integer <int64>

optional

ID do Departamento que está efetuando o Envio

nome

string

optional

Nome do Departamento que está efetuando o Envio

conteudo

array[object (PrePostagemApiConteudoRequest) {6}]

optional

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

descricao

string

required

Descrição do Conteúdo

linha

string

optional

Descrição da Linha de Produto

quantidade

integer <int64>

required

Quantidade do Conteúdo

sku

string

optional

SKU - Unidade de Manutenção de Estoque

valorTotal

number

required

Valor Total do Conteúdo

valorUnitario

number

required

Valor Unitário do Conteúdo

dadosExtraNotaFiscal

object (PrePostagemMiniDanfeRequest)

optional

JSON para informar os Dados para Impressão de MiniDanfe

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

dataEstimadaEntrega

string <date>

optional

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

Example:

2012-07-04

dataNotaFiscal

string <date>

optional

Data da Nota Fiscal do Objeto

destinatario

object (PrePostagemApiDestinatarioRequest)

optional

JSON para informar o Destinatário da etiqueta inserida no TMS Boxlink

aosCuidados

string

optional

Nome de quem receberá o Envio

bairro

string

required

Bairro do Destinatário

cep

string

required

CEP do Destinatário

cidade

string

required

Cidade do Destinatário

complemento

string

optional

Complemento do Endereço do Destinatário

documento

string

optional

Número do Documento (CPF ou CNPJ

string

optional

E-mail do Destinatário

empresa

string

optional

Nome da Empresa do Destinatário

ignorarValidacaoDeCep

boolean

required

Marcar true caso não seja necessario validar o cep

inscricaoEstadual

string

optional

Inscrição Estadual do Destinatário

latitude

number

optional

Latitude do Endereço do Destinatário

Example:

15.12345

logradouro

string

required

Logradouro do Destinatário

longitude

number

optional

Longitude do Endereço do Destinatário

Example:

95.12345

nome

string

required

Nome do Destinatário

numero

string

required

Número do Endereço do Destinatário

pontoReferencia

string

optional

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

telefone

string

optional

Telefone do Destinatário

tipoDocumento

integer <int32>

optional

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

string

required

UF do Destinatário

identificadorERP

string

optional

Informe a identificacao ERP para o preenvio

identificadorEcommerce

string

optional

Informe a identificacao do Ecommerce para o preenvio

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.

marcarComoImpressa

boolean

optional

Informe true caso a etiqueta já tenha sido impressa. O padrão é false.

meuServicoId

integer <int64>

optional

Id do Meu Serviço no TMS Boxlink

estrategiaFreteId

integer

optional

Id da estratégia de frete no TMS Boxlink

estrategiaFreteNome

string

optional

Nome da estratégia de frete na Boxlink

meuServicoNome

string

optional

Nome da estratégia de frete na Boxlink

multiVolume

boolean

optional

numeroNotaFiscal

string

optional

Número da Nota Fiscal do Objeto

observacao

string

optional

Campo livre para inserir observações

plataforma

string

optional

Plataforma de origem do Envio (API, ERP, VTEX, SHOPIFY, etc...)

serieNotaFiscal

string

optional

Série da Nota Fiscal do Objeto

valorDeclarado

number

optional

Valor Declarado do Objeto

valorNotaFiscal

number

optional

Valor da Nota Fiscal do Objeto

valorServicoEstimado

number

optional

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

versao

string

optional

Versão da plataforma de origem do Envio

volumes

array [object {7}]

optional

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

peso

string

optional

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)

identificadorDoVolume

string

required

Codigo para identificar o volume. Chave única e OBRIGATÓRIA

identificadorPedido

string

required

Identificador do pedido na loja ou e-commerce

dataCriacaoPedidoLoja

string

optional

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

sellerId

integer

optional

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

Example

{
    "adicionais": [
        {
            "siglaAdicional": "AR"
        }
    ],
    "chaveCliente": "string",
    "chaveNotaFiscal": "string",
    "clienteDepto": {
        "codReferencia": "string",
        "id": 0,
        "nome": "string"
    },
    "conteudo": [
        {
            "descricao": "string",
            "linha": "string",
            "quantidade": 0,
            "sku": "string",
            "valorTotal": 0,
            "valorUnitario": 0
        }
    ],
    "dadosExtraNotaFiscal": {
        "dataEmissao": "string",
        "dataRecebimento": "string",
        "destinatarioIe": "string",
        "emitenteDocumento": "string",
        "emitenteIe": "string",
        "emitenteNome": "string",
        "protocolo": "string"
    },
    "dataEstimadaEntrega": "2012-07-04",
    "dataNotaFiscal": "2019-08-24",
    "destinatario": {
        "aosCuidados": "string",
        "bairro": "string",
        "cep": "string",
        "cidade": "string",
        "complemento": "string",
        "documento": "string",
        "email": "string",
        "empresa": "string",
        "ignorarValidacaoDeCep": true,
        "inscricaoEstadual": "string",
        "latitude": 15.12345,
        "logradouro": "string",
        "longitude": 95.12345,
        "nome": "string",
        "numero": "string",
        "pontoReferencia": "string",
        "telefone": "string",
        "tipoDocumento": 0,
        "uf": "string"
    },
    "identificadorERP": "string",
    "identificadorEcommerce": "string",
    "inserirOcorrencia": true,
    "descricaoOcorrencia": "string",
    "marcarComoImpressa": true,
    "meuServicoId": 0,
    "estrategiaFreteId": 0,
    "estrategiaFreteNome": "string",
    "meuServicoNome": "string",
    "multiVolume": true,
    "numeroNotaFiscal": "string",
    "observacao": "string",
    "plataforma": "string",
    "serieNotaFiscal": "string",
    "valorDeclarado": 0,
    "valorNotaFiscal": 0,
    "valorServicoEstimado": 0,
    "versao": "string",
    "volumes": [
        {
            "peso": "string",
            "formato": "ENVELOPE",
            "altura": 0,
            "largura": 0,
            "comprimento": 0,
            "diametro": 0,
            "identificadorDoVolume": "string"
        }
    ],
    "identificadorPedido": "string",
    "dataCriacaoPedidoLoja": "string",
    "sellerId": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.boxlink.com.br/v2/etiqueta/atualizar/' \
--header 'Authorization;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "adicionais": [
        {
            "siglaAdicional": "AR"
        }
    ],
    "chaveCliente": "string",
    "chaveNotaFiscal": "string",
    "clienteDepto": {
        "codReferencia": "string",
        "id": 0,
        "nome": "string"
    },
    "conteudo": [
        {
            "descricao": "string",
            "linha": "string",
            "quantidade": 0,
            "sku": "string",
            "valorTotal": 0,
            "valorUnitario": 0
        }
    ],
    "dadosExtraNotaFiscal": {
        "dataEmissao": "string",
        "dataRecebimento": "string",
        "destinatarioIe": "string",
        "emitenteDocumento": "string",
        "emitenteIe": "string",
        "emitenteNome": "string",
        "protocolo": "string"
    },
    "dataEstimadaEntrega": "2012-07-04",
    "dataNotaFiscal": "2019-08-24",
    "destinatario": {
        "aosCuidados": "string",
        "bairro": "string",
        "cep": "string",
        "cidade": "string",
        "complemento": "string",
        "documento": "string",
        "email": "string",
        "empresa": "string",
        "ignorarValidacaoDeCep": true,
        "inscricaoEstadual": "string",
        "latitude": 15.12345,
        "logradouro": "string",
        "longitude": 95.12345,
        "nome": "string",
        "numero": "string",
        "pontoReferencia": "string",
        "telefone": "string",
        "tipoDocumento": 0,
        "uf": "string"
    },
    "identificadorERP": "string",
    "identificadorEcommerce": "string",
    "inserirOcorrencia": true,
    "descricaoOcorrencia": "string",
    "marcarComoImpressa": true,
    "meuServicoId": 0,
    "estrategiaFreteId": 0,
    "estrategiaFreteNome": "string",
    "meuServicoNome": "string",
    "multiVolume": true,
    "numeroNotaFiscal": "string",
    "observacao": "string",
    "plataforma": "string",
    "serieNotaFiscal": "string",
    "valorDeclarado": 0,
    "valorNotaFiscal": 0,
    "valorServicoEstimado": 0,
    "versao": "string",
    "volumes": [
        {
            "peso": "string",
            "formato": "ENVELOPE",
            "altura": 0,
            "largura": 0,
            "comprimento": 0,
            "diametro": 0,
            "identificadorDoVolume": "string"
        }
    ],
    "identificadorPedido": "string",
    "dataCriacaoPedidoLoja": "string",
    "sellerId": 0
}'

Responses

🟢200OK

application/json

Body

Retorno de uma etiqueta inserida no TMS Boxlink

dataCriacao

string <date>

optional

Data da Criação

horaCriacao

object (LocalTime)

optional

hour

integer <int32>

optional

minute

integer <int32>

optional

nano

integer <int32>

optional

second

integer <int32>

optional

integer <int64>

optional

ID da etiqueta

rastreadorTms

string

optional

Código de Rastreio

Example

{
    "dataCriacao": "2019-08-24",
    "horaCriacao": {
        "hour": 0,
        "minute": 0,
        "nano": 0,
        "second": 0
    },
    "id": 0,
    "rastreadorTms": "string"
}