API Boxlink

Inserir ocorrência no Pedido

Ambiente de Produção

https://api.boxlink.com.br

POST

/v2/pre-envio/ocorrencia/{rastreadorTms}

API do Seller/Loja | Rastreamento

Request

Path Params

rastreadorTms

string

required

RastreadorTms

Example:

XYZ0123456789

Header Params

Authorization

string

required

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

Body Params application/json

JSON para inserir Ocorrência de Pré-Envio no TMS Boxlink

dataHoraDaOcorrencia

string <date-time>

optional

Data e Hora da Ocorrência

Example:

2014-06-25T00:00:00.000Z

descricao

string

optional

Descrição da Ocorrência

Example:

loren ipsilon

detalhe

string

optional

Detalhe da Ocorrência

Example:

loren ipsilon

exibicaoPublica

boolean

optional

Exibição Pública da Ocorrência

Example:

true

origemCep

string

optional

CEP de Origem da Ocorrência

Example:

01302-000

origemCidade

string

optional

Cidade de Origem da Ocorrência

Example:

São Paulo

origemLocal

string

optional

Local de Origem da Ocorrência

origemUf

string

optional

UF de Origem da Ocorrência

Example:

urlImagem

string

optional

URL da imagem do comprovante da Ocorrência

Example:

https://url.de.uma.imagem.com

Example

{
    "dataHoraDaOcorrencia": "2014-06-25T00:00:00.000Z",
    "descricao": "loren ipsilon",
    "detalhe": "loren ipsilon",
    "exibicaoPublica": true,
    "origemCep": "01302-000",
    "origemCidade": "São Paulo",
    "origemLocal": "string",
    "origemUf": "SP",
    "urlImagem": "https://url.de.uma.imagem.com"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.boxlink.com.br/v2/pre-envio/ocorrencia/XYZ0123456789' \
--header 'Authorization;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dataHoraDaOcorrencia": "2014-06-25T00:00:00.000Z",
    "descricao": "loren ipsilon",
    "detalhe": "loren ipsilon",
    "exibicaoPublica": true,
    "origemCep": "01302-000",
    "origemCidade": "São Paulo",
    "origemLocal": "string",
    "origemUf": "SP",
    "urlImagem": "https://url.de.uma.imagem.com"
}'

Responses

🟢201Ocorrência cadastrada

application/json

Body

object {0}

Example

{}

🟠400Erro de validação

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

🔴500Exceção não esperada

Alterar os volumes do Pedido

Inserir um Pedido