Pesquisar cotação para múltiplos sellers

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

array of:

dadosDaCotacao

object

optional

cepDestino

string

required

Cep de Destino do Envio

cepOrigem

string

required

Cep de Origem do Envio

adicionarHandlingTime

boolean

required

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

Example:

false

tiposDeProdutos

array[string]

optional

Listagem dos tipos de produtos que fazem parte da cotação. Ex.: Inflamável, Perecível.

envioReverso

boolean

optional

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

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 Adicionais

tipoAgrupamento

enum<string>

optional

Padrão é MULTIVOLUME, caso deseje o tipo de agrupamento para quando existir mais de um volume na cotação deve informar AGRUPADO

Allowed values:

AGRUPADOMULTIVOLUME

tipoDocumentoFiscal

enum<string>

optional

Tipo de documento fiscal (NOTA_FISCAL ou DECLARACAO_CONTEUDO)

Allowed values:

NOTA_FISCALDECLARACAO_CONTEUDO

volumes

array [object {6}]

required

JSON com os volumes do envio

identificadorCanal

integer <int64>

optional

identificadorSeller

string

optional

Example

[
  {
    "dadosDaCotacao": {
      "cepDestino": "31270901",
      "cepOrigem": "30110002",
      "adicionarHandlingTime": true,
      "tipoAgrupamento": "MULTIVOLUME",
      "tiposDeProdutos": [
        "inflamavel",
        "perecivel"
      ],
      "valorDeclarado": 150.68,
      "volumes": [
        {
          "peso": 650,
          "formato": "CAIXA",
          "altura": 10,
          "largura": 30,
          "comprimento": 38,
          "diametro": 0
        }
      ]
    },
    "identificadorSeller": "9"
  }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Retorna a cotação com seus dados de preço e prazo

application/json

Body

array of:

cotacoes

array[object (PrecoPrazoResponse) {15}]

optional

detalhePrazo

string

optional

Texto para Entrega no Mesmo Dia

disponivel

boolean

optional

Serviço disponível?

excecoes

array[string]

optional

Lista com o motivo de indisponibilidade dos serviços que não atendem o envio

idServico

integer <int64>

optional

ID do Serviço

motivoIndisponibilidade

string

optional

Motivo da indisponibilidade quando indisponível

nomeServico

string

optional

Nome do Serviço

observacoes

string

optional

Observações

prazo

integer <int64>

optional

Prazo do Envio (em dias)

dataPrevistaParaEntrega

string

optional

data prevista da entrega considerando o prazo em dias úteis

preRequisito

enum<string>

optional

Pre-requisito para utilização do serviço

Allowed values:

SOMENTE_NF_COM_CHAVESOMENTE_DECLARACAO_COM_DOCUMENTONF_COM_CHAVE_OU_DECLARACAO_COM_DOCUMENTONF_OU_DECLARACAOALERTA_NF_SEM_CHAVE_OU_DECLARACAO_SEM_DOCUMENTONAO_SE_APLICA

preco

number

optional

Preço do Envio

precoParaExibicao

string

optional

Valor da cotação somente para exibição

tags

array[string]

optional

Lista das tags identificadoras da estratégia de frete

nomeTransportadoraLastMile

string

optional

Nome da trasnportadora lastmile que foi eleita na cotação

nomeServicoLastMile

string

optional

Nome do serviço da trasnportadora lastmile que foi eleita na cotação

excecoes

array[string]

optional

identificadorSeller

string

optional

Example

[
  {
    "cotacoes": [
      {
        "detalhePrazo": "string",
        "disponivel": true,
        "excecoes": [
          "string"
        ],
        "idServico": 0,
        "motivoIndisponibilidade": "string",
        "nomeServico": "string",
        "observacoes": "string",
        "prazo": 0,
        "dataPrevistaParaEntrega": "string",
        "preRequisito": "SOMENTE_NF_COM_CHAVE",
        "preco": 0,
        "precoParaExibicao": "string",
        "tags": [
          "string"
        ],
        "nomeTransportadoraLastMile": "string",
        "nomeServicoLastMile": "string"
      }
    ],
    "excecoes": [
      "string"
    ],
    "identificadorSeller": "string"
  }
]

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

🟠404Esta cotação ultrapassou o Limite máximo para cotação de 10 sellers

🔴500Exceção não esperada