Skip to main content
POST
Simular frete de um pedido

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Body

application/json

Representa os dados necessários para realizar o cálculo de frete

order_id
integer
required

ID do pedido cujo frete será simulado. Precisa existir na loja.

Example:

123

zipcode
string
required

CEP de destino usado na simulação.

Example:

"14940000"

total
number<float>
required

Valor total dos produtos, em reais, considerado na simulação.

Example:

430

skus_ids
integer[]
required

IDs dos SKUs considerados na simulação. Todos precisam existir na loja.

Example:
quantities
integer[]
required

Quantidade de cada SKU, na mesma ordem de skus_ids. A lista precisa ter o mesmo tamanho.

Example:
origin
string

Origem da simulação, repassada ao serviço de logística.

Example:

"product_page"

utm_email
string

E-mail do comprador repassado ao serviço de logística junto da simulação.

Example:

"john@snow.com"

Response

Cálculo do frete realizado com sucesso

data
object

Cotação de frete calculada para o CEP de destino informado.