Pesquisar cotação - API Boxlink

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

adicionarHandlingTime

boolean

required

Atributo é por padrão FALSE, deve ser TRUE caso deseje adicionar o Handling Time à estimativa de prazo do Envio

Example:

false

mostrarFretesIndisponiveis

boolean

optional

Atributo é por padrão FALSE, caso coloque TRUE o response irá retornar também as Estratégias de Frete que estão indisponíveis para a cotação realizada.

filtrarComTags

array[string]

optional

Insira a lista de TAGs que a estratégia de frete deve conter para filtrar no resultado

cepDestino

string

required

Cep de Destino do Envio

cepOrigem

string

required

Cep de Origem do Envio. *Se não informado será considerado o CEP do cadastro na Boxlink

envioReverso

boolean

optional

Atributo é por padrão FALSE, deve ser TRUE caso seja um Envio Reverso

Example:

false

host

string

optional

Endereco do site que esta fazendo cotação

idCarrinho

string

optional

Idenfificador do carrinho de compras

pontoReferenciaDestino

string

optional

siglaAdicionais

array[string]

optional

Siglas dos Serviços Adicionais dos Correios - Usado somente nas cotações de Correios

tipoDocumentoFiscal

enum<string>

optional

Tipo de documento fiscal (NOTA_FISCAL ou DECLARACAO_CONTEUDO)

Allowed values:

NOTA_FISCALDECLARACAO_CONTEUDO

valorDeclarado

number

required

Valor declarado para seguro

volumes

array [object {6}]

required

JSON com os volumes do envio

peso

integer

required

Peso do Volume (gramas)

formato

enum<string>

required

Formato do Volume

Allowed values:

ENVELOPECILINDROCAIXA

altura

integer

required

Altura do Volume (cm)

largura

integer

required

Largura do Volume (cm)

comprimento

integer

required

Comprimento do Volume (cm)

diametro

integer

optional

Diâmetro do Volume quando Cilindro (cm). * Obrigatório somente se o formato for CILINDRO

idSeller

integer

optional

Id do seller na Boxlink *Obrigatório quando for utilizado um token que não contenha o identificador do Seller.

Example

{
  "cepOrigem": "04613-001",
  "cepDestino": "40060-055",
  "adicionarHandlingTime": true,
  "valorDeclarado": 195.56,
  "volumes": [
    {
      "peso": 1500,
      "formato": "CAIXA",
      "altura": 50,
      "largura": 50,
      "comprimento": 50,
      "diametro": 0
    }
  ]
}

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/v2/preco-prazo' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
   "cepOrigem":"04613-001",
   "cepDestino":"40060-055",
   "adicionarHandlingTime":true,
   "valorDeclarado": 195.56,
   "volumes":[
      {
         "peso":1500,
         "formato":"CAIXA",
         "altura":50,
         "largura":50,
         "comprimento":50,
         "diametro":0
      }
   ]
}'

Responses

🟢200Retorna uma lista JSON de opções de envio com preço e prazo em dias

application/json

Body

array of:

idServico

integer

required

nomeServico

string

required

preco

number

required

prazo

integer

required

detalhePrazo

null

required

dataPrevistaParaEntrega

string

required

nomeServicoLastMile

string

required

nomeTransportadoraLastMile

string

required

disponivel

boolean

required

motivoIndisponibilidade

null

required

observacoes

null

required

preRequisito

null

required

excecoes

array[string]

required

tags

array[string]

required

precoParaExibicao

string

required

cotacaoId

string

optional

cepOrigem

string

optional

cnpjTransportadoraLastMile

string

optional

valorAcrescimoApi

null

optional

valorDescontoApi

null

optional

Example

[
  {
    "cotacaoId": "6ff448d7-a879-4ed4-b49a-039bce082e54",
    "idServico": 7,
    "nomeServico": "JADLOG",
    "cepOrigem": "04144-000",
    "preco": 334.32,
    "prazo": 4,
    "detalhePrazo": null,
    "dataPrevistaParaEntrega": "2024-03-05",
    "nomeServicoLastMile": "JADLOG",
    "nomeTransportadoraLastMile": "JADLOG",
    "cnpjTransportadoraLastMile": "04884082000135",
    "disponivel": true,
    "motivoIndisponibilidade": null,
    "observacoes": null,
    "preRequisito": null,
    "excecoes": [],
    "tags": [
      "tintas",
      "inflamável"
    ],
    "valorAcrescimoApi": null,
    "valorDescontoApi": null,
    "precoParaExibicao": "R$ 334.32"
  }
]

🟠400Erro de validação

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

🔴500Exceção não esperada