Skip to main content
POST
Verificar disponibilidade e preços de entrega
Este endpoint permite verificar se há veículos disponíveis para realizar uma entrega e obter informações sobre os preços antes de criar uma nova solicitação de entrega. Informações retornadas:
  • Preço de entrega calculado
  • Veículos disponíveis e seus tipos
  • Quantidade total de veículos disponíveis

Authorizations

Authorization
string
header
required

Token de acesso OAuth 2.0 obtido através do endpoint /oauth/token.

Use o formato: Authorization: Bearer {access_token}

O token deve ser incluído em todas as requisições aos endpoints protegidos.

Body

application/json
pickupAddress
object
required

Endereço de coleta do pedido.

returnToMerchant
boolean
required

Informa se o entregador deve retornar ao endereço de coleta após a entrega ter sido efetuada.

Example:

false

canCombine
boolean
required

Se a entrega pode ser combinada com outras

Example:

false

deliveryAddress
object
required

Endereço de entrega do pedido.

vehicle
object
required
limitTimes
object
required
totalOrderPrice
object
required
totalWeight
integer
required

Peso total do pedido em gramas

Required range: x >= 0
Example:

500

merchant
object
orderDeliveryFee
object
packageVolume
integer

Volume do pacote em centímetros cúbicos

Required range: x >= 0
Example:

2000

packageQuantity
integer

Quantidade de pacotes

Required range: x >= 1
Example:

1

specialInstructions
string

Instruções especiais para a entrega

Example:

"Produto frágil"

additionalPricePercentual
number<float>

Percentual adicional no preço (0-100)

Required range: 0 <= x <= 100
Example:

10.5

onlinePayment
boolean

Se o pagamento é online

Example:

true

Response

Disponibilidade e preços calculados com sucesso

deliveryPrice
object
required
vehicles
object
required