Aferir e Triar um Pedido

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

rastreadorTms

string

required

Rastreador da Boxlink do envio a ser aferido e triado.

urlImagem

string

optional

Opcional caso possua uma imagem do pacote para incorporar na página de rastreio deve ser informada a URL aqui

volumes

array [object {7}]

required

peso

integer <int64>

required

O peso deve ser informado em gramas

formato

enum<string>

required

O formato deve ser CAIXA, ENVELOPE ou CILINDRO

Allowed values:

ENVELOPECILINDROCAIXA

altura

integer <int64>

required

Obrigatório somente para o formato CAIXA em centímetros

largura

integer <int64>

required

Obrigatório somente para o formato CAIXA e ENVELOPE em centímetros

comprimento

integer <int64>

required

Obrigatório somente para o formato CAIXA, ENVELOPE e CILINDRO em centímetros

diametro

integer <int64>

required

Obrigatório somente para o formato CILINDRO em centímetros

identificadorDoVolume

string

optional

Obrigatório nos casos de existir mais de um volume no pedido

Example

{
    "rastreadorTms": "PRO9F00000018",
    "urlImagem": "https://img-repo/uploads/abcd.jpg",
    "volumes": [
        {
            "peso": 826,
            "formato": "CAIXA",
            "altura": 28,
            "largura": 33,
            "comprimento": 29,
            "diametro": 0,
            "identificadorDoVolume": "_01"
        }
    ]
}

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/envio/aferir-triar' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rastreadorTms": "PRO9F00000018",
    "urlImagem": "https://img-repo/uploads/abcd.jpg",
    "volumes": [
        {
            "peso": 826,
            "formato": "CAIXA",
            "altura": 28,
            "largura": 33,
            "comprimento": 29,
            "diametro": 0,
            "identificadorDoVolume": "_01"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

envio

object (EnvioAferidoDescritivoResponse)

optional

cep

string

optional

descricaoTrechos

string

optional

estrategiaFreteNome

string

optional

id

integer <int64>

optional

peso

integer <int64>

optional

rastreadorTms

string

optional

valorComercial

number

optional

valorCustoEstimado

number

optional

excecoes

array[object (ExcecaoTextual) {1}]

optional

excecao

string

optional

mensagemDeRetorno

string

optional

status

enum<string>

optional

Allowed values:

SUCESSOSUCESSO_COM_AVISOERRO_TEMPORARIOERRO_PROCESSAMENTOACAO_INVALIDA

Example

{
    "envio": {
        "cep": "string",
        "descricaoTrechos": "string",
        "estrategiaFreteNome": "string",
        "id": 0,
        "peso": 0,
        "rastreadorTms": "string",
        "valorComercial": 0,
        "valorCustoEstimado": 0
    },
    "excecoes": [
        {
            "excecao": "string"
        }
    ],
    "mensagemDeRetorno": "string",
    "status": "SUCESSO"
}

🟢201Retorna um JSON com informações do envio aferido e triado

🟠400Erro de validação

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

🔴500Exceção não esperada