Pesquisar envios da transportadora de uma determinada situação TMS Boxlink

Request

Path Params

sellerId

integer

required

sellerId

situacao

string

required

Filtro da Situação do Envio

Query Params

dataFim

string

optional

Filtro de data final

dataInicio

string

optional

Filtro de data incial

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}

Responses

🟢200Retorna um JSON com os envios da situação definida na requisição

application/json

Body

array of:

chaveSeller

string

optional

Identificador do pedido do Seller

Example:

1234A

dataEnviado

string <date>

optional

Data de criação do envio

Example:

2012-07-04

dataEstimadaEntrega

string <date>

optional

Data prevista para entrega

Example:

2012-07-04

dataSituacao

string <date-time>

optional

Data da situação do envio

Example:

2012-07-04T09:00:00

destinatario

object (EnvioDestinatarioResponse)

optional

JSON de retorno com dados do destinatário do envio

aosCuidados

string

optional

Nome de quem receberá o Envio

Example:

Seu Chico

bairro

string

optional

Bairro do Destinatário

Example:

Centro

cep

string

optional

CEP do Destinatário

Example:

63800-959

cidade

string

optional

Cidade do Destinatário

Example:

Quixeramobim

complemento

string

optional

Complemento do Endereço do Destinatário

Example:

Casa Verde

documento

string

optional

Número do Documento do Destinatário (CPF ou CNPJ)

Example:

460.254.270-03

string

optional

E-mail do Destinatário

Example:

francisco@buarque.com

logradouro

string

optional

Logradouro do Destinatário

Example:

Rua do Anjo

nome

string

optional

Nome do Destinatário

Example:

Francisco Buarque

numero

string

optional

Número do Endereço do Destinatário

Example:

S/N

pontoReferencia

string

optional

Ponto de Referência do Endereço do Destinatário

Example:

Rua sem saída

telefone

string

optional

Telefone do Destinatário

Example:

(85) 1234-5678

string

optional

UF do Destinatário

Example:

estrategiaDeFrete

string

optional

Nome da estratégia de frete

Example:

SEDEX HOJE

estrategiaDeFreteId

integer <int64>

optional

Identificador da estratégia de frete

Example:

numeroNotaFiscal

string

optional

Número da nota fisca

Example:

1256

rastreadorTms

string

optional

Código de rastreio do TMS

Example:

BLK123456789

situacao

string

optional

Situação do envio no TMS

Example:

ENTREGUE

situacaoId

integer <int64>

optional

Identificador da situação no TMS

Example:

volumes

integer <int64>

optional

Quantidade de objetos do enio

Example:

Example

[
  {
    "chaveSeller": "1234A",
    "dataEnviado": "2012-07-04",
    "dataEstimadaEntrega": "2012-07-04",
    "dataSituacao": "2012-07-04T09:00:00",
    "destinatario": {
      "aosCuidados": "Seu Chico",
      "bairro": "Centro",
      "cep": "63800-959",
      "cidade": "Quixeramobim",
      "complemento": "Casa Verde",
      "documento": "460.254.270-03",
      "email": "francisco@buarque.com",
      "logradouro": "Rua do Anjo",
      "nome": "Francisco Buarque",
      "numero": "S/N",
      "pontoReferencia": "Rua sem saída",
      "telefone": "(85) 1234-5678",
      "uf": "CE"
    },
    "estrategiaDeFrete": "SEDEX HOJE",
    "estrategiaDeFreteId": 12,
    "numeroNotaFiscal": 1256,
    "rastreadorTms": "BLK123456789",
    "situacao": "ENTREGUE",
    "situacaoId": 1,
    "volumes": 1
  }
]

🟠400Erro de validação

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

🟠403Forbidden!

🟠404Não encontrado

🔴500Exceção não esperada

Pesquisar envios da transportadora de uma determinada situação TMS Boxlink

Request

Request samples

Responses