Saltar al contenido principal
POST
Cotiza un envío

Autorizaciones

Authorization
string
header
requerido

Tu llave de API, enviada como Authorization: Bearer <key>. Las llaves reales y de prueba son distintas; la llave que envías decide en qué modo actúa la llamada. Para probar llamadas, usa una llave de prueba (empieza con lst_test_): no se envía ningún repartidor real y no se mueve dinero real, pero los webhooks se disparan y el dropoff.phone que des puede recibir mensajes de WhatsApp, así que usa tu propio número. Una llave real (empieza con lst_live_) reserva y cobra envíos reales.

Cuerpo

application/json

El viaje a cotizar.

store_id
string
requerido

El id st_ de la tienda de donde recoge el repartidor.

dropoff
object
requerido

A dónde va el pedido.

payment_method
enum<string>

Cómo paga el cliente.

Opciones disponibles:
prepaid,
cash,
card
order_value_cents
integer

El valor del pedido, en centavos. Obligatorio para una cotización cash, donde es lo que cobra el repartidor.

Rango requerido: x >= 0
business_fee_share
integer

El porcentaje de la tarifa de envío que paga la tienda. Por omisión es el de la propia tienda.

Rango requerido: 0 <= x <= 100
business_fee_cap_cents
integer

Lo máximo que paga la tienda para la tarifa, en centavos.

Rango requerido: x >= 0
pickup_ready_at
string<date-time>

Cuándo estará listo el pedido, en ISO-8601 en UTC. Debe ser en el futuro.

vehicle
enum<string>

Por omisión es moto.

Opciones disponibles:
moto,
car
manifest
object | null

La lista descriptiva de artículos para el repartidor. El dinero nunca sale de ella; su único efecto en el viaje es que un artículo xlarge lo convierte en auto. Ausente, null, {} y {"items": null} significan todos que no hay carrito.

Respuesta

Creado.

Un envío cotizado y apartado por un momento. Pasa id a POST /v1/deliveries como quote_id para reservar exactamente a este precio.

id
string
requerido

El id de la cotización, con prefijo qt_.

Ejemplo:

"qt_5nW3jP8vT2xQ6bM9cZ1sRdKe"

fee_cents
integer
requerido

La tarifa de envío total, en centavos, y el número al que se sujeta una reserva de esta cotización. business_fee_cents más customer_fee_cents siempre suman esa cifra.

business_fee_cents
integer
requerido

La parte de la tarifa que paga la tienda.

customer_fee_cents
integer
requerido

La parte de la tarifa que paga el cliente.

cash_to_collect_cents
integer | null
requerido

Lo que cobra el repartidor en la puerta en un pedido en efectivo: el valor del pedido más la parte de la tarifa que paga el cliente. Null en toda cotización que no sea en efectivo, lo cual no es lo mismo que 0 (un pedido en efectivo que no cobra nada).

currency
enum<string>
requerido

Siempre MXN; el dinero va en centavos enteros.

Opciones disponibles:
MXN
pickup_duration_min
integer | null
requerido

Minutos hasta que se espera un repartidor en la tienda, cuando la cotización regresó con una estimación. Null en otro caso.

dropoff_eta_at
string<date-time> | null
requerido

Cuándo se espera el pedido en la puerta, cuando la cotización regresó con una estimación. Null en otro caso.

expires_at
string<date-time>
requerido

El plazo para reservar este precio. Pasado ese plazo, una creación responde quote_expired y tienes que volver a cotizar.

test
boolean
requerido

Si la cotización pertenece al mundo de pruebas.

created_at
string<date-time>
requerido
vehicle
enum<string>
requerido

Para qué se armó este precio: car cuando pediste uno o un artículo tiene tamaño xlarge, moto en otro caso. Siempre presente.

Opciones disponibles:
moto,
car
Ejemplo:

"moto"