API Boxlink

Pesquisar Status do Ciclo de Vida do Pedido

Testing

Ambiente de Produção

https://api.boxlink.com.br

GET

/v2/pedido/{rastreadorTms}/status

Request

Path Params

rastreadorTms

string

required

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}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

array of:

data

object

optional

lifecycleStage

string

required

Etapa do Ciclo de Vida

lifecycleLastUpdate

string

required

Data e Hora da Última Atualização do Ciclo de Vida

estimatedDeliveryDate

string

required

Data Prevista para Entrega

date

string

optional

exceptions

array[object (StandardException) {2}]

optional

string

optional

message

string

optional

resource

string

optional

success

boolean

optional

Example

{
    "resource": "http://api.boxlink.com.br/v2/pedido/TSTF6000CB040/status",
    "date": "2024-05-10T10:23:04.362459790",
    "success": true,
    "exceptions": [],
    "data": {
        "lifecycleStage": "ENTREGUE",
        "lifecycleLastUpdate": "2024-02-05",
        "estimatedDeliveryDate": "2024-02-06"
    }
}

🟢201Retorna um JSON com informações de preenvios com o numero do pedido

🟠400Erro de validação

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

🟠403Forbidden!

🔴500Exceção não esperada

Pesquisar Pedido pelo Identificador do Pedido

Inserir Envio para Tracking