API Boxlink

Alterar o destinatário do Pedido

Ambiente de Produção

https://api.boxlink.com.br

PUT

/v2/pre-envio/destinatario

API do Seller/Loja | Pré 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

JSON para reenviar o Destinatário de uma etiqueta no TMS Boxlink

chaveCliente

string

optional

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

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

rastreadorTms

string

optional

Código de rastreio do TMS

Example

{
    "chaveCliente": "string",
    "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"
    },
    "rastreadorTms": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.boxlink.com.br/v2/pre-envio/destinatario' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chaveCliente": "string",
    "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"
    },
    "rastreadorTms": "string"
}'

Responses

🟢200Volumes processados com sucesso

application/json

Body

object {0}

Example

{}

🟠400Erro de validação

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

🟠404Pré envio não encontrado

🔴500Exceção não esperada

Pesquisar um Pedido (Pré-envio)

Alterar os volumes do Pedido