API Boxlink

Inserir Solicitação de Logística Reversa

Ambiente de Produção

https://api.boxlink.com.br

POST

/v2/logistica-reversa/solicitar

API do Canal Logístico | Logística Reversa

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 de Logistica reversa

chaveSeller

string

required

Identificador do Seller

Example:

codigoControle

string

optional

Código de controle

Example:

001

conteudo

array[object (LogisticaReversaConteudoRequest) {3}]

optional

Json de informações da declaração de conteudo (Se não houver, é necessário informar condições de nota fiscal)

descricao

string

optional

Descrição do conteudo

Example:

Tesoura

quantidade

integer <int64>

required

Quantidade de objetos para um mesmo tipo de produto

Example:

valorUnitario

number

required

Valor Unitário de cada produto

Example:

estrategiaFreteId

string

required

Identificador da Estratégia de Frete

Example:

notaFiscal

object (LogisticaReversaNotaFiscalRequest)

optional

JSON de nota fiscal (Se não houver, é necessário declarar conteudo)

chave

string

required

Chave de Nota Fiscal

Example:

data

string

required

Data da Nota Fiscal

Example:

2020-09-16

numero

string

required

Número de Nota Fiscal

Example:

serie

string

required

Sério de Nota Fiscal

Example:

valor

number

required

Valor de Nota Fiscal

Example:

1235

observacao

string

optional

Observação a ser adicionada no pacote de envio reverso

Example:

Frágil

rastreadorTms

string

required

Identificador de Rastreio do TMS

Example:

BLK000000002132

validadeEmDiasCorridos

integer <int32>

required

Validade em dias corridos para envio reverso de 1 a 30

Example:

valorDeclaradoParaSeguro

number

optional

Valor declarado para seguro do envio reverso

Example:

volume

object (LogisticaReversaVolumeRequest)

required

JSON de volume para Envio Reverso

altura

integer <int64>

required

Dimensão da altura do volume em centímetros

Example:

comprimento

integer <int64>

required

Dimensão do comprimento do volume em centímetros

Example:

diametro

integer <int64>

optional

Dimensão do diametro do volume em centímetros

Example:

formato

enum<string>

required

Formato dos volume

Allowed values:

ENVELOPECILINDROCAIXAMALA

Example:

CAIXA/ENVELOPE/CILINDRO

largura

integer <int64>

required

Dimensão da largura do volume em centímetros

Example:

peso

integer <int64>

required

Peso do Volume em gramas

Example:

100

Example

{
  "chaveSeller": 1,
  "codigoControle": "001",
  "conteudo": [
    {
      "descricao": "Tesoura",
      "quantidade": 1,
      "valorUnitario": 10
    }
  ],
  "estrategiaFreteId": 53,
  "notaFiscal": {
    "chave": 42,
    "data": "2020-09-16",
    "numero": 42,
    "serie": 42,
    "valor": 1235
  },
  "observacao": "Frágil",
  "rastreadorTms": "BLK000000002132",
  "validadeEmDiasCorridos": 1,
  "valorDeclaradoParaSeguro": 10,
  "volume": {
    "altura": 20,
    "comprimento": 20,
    "diametro": 20,
    "formato": "CAIXA/ENVELOPE/CILINDRO",
    "largura": 20,
    "peso": 100
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.boxlink.com.br/v2/logistica-reversa/solicitar' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chaveSeller": 1,
    "codigoControle": "001",
    "conteudo": [
        {
            "descricao": "Tesoura",
            "quantidade": 1,
            "valorUnitario": 10
        }
    ],
    "estrategiaFreteId": 53,
    "notaFiscal": {
        "chave": 42,
        "data": "2020-09-16",
        "numero": 42,
        "serie": 42,
        "valor": 1235
    },
    "observacao": "Frágil",
    "rastreadorTms": "BLK000000002132",
    "validadeEmDiasCorridos": 1,
    "valorDeclaradoParaSeguro": 10,
    "volume": {
        "altura": 20,
        "comprimento": 20,
        "diametro": 20,
        "formato": "CAIXA/ENVELOPE/CILINDRO",
        "largura": 20,
        "peso": 100
    }
}'

Responses

🟢200Retorna um JSON com status 201 e CREATED caso tudo tenha dado certo

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
}

🟠400Erro de validação

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

🔴500Exceção não esperada

Modified at 2023-03-01 21:32:12

Imprimir etiqueta da Transportadora do Envio

Pesquisar ocorrências por e-mail