Referencia de la API

GET /v1/me/membership

Beta Compatible con sandbox

Si este cliente tiene una membresía Ryde One activa. Consúltalo antes de ofrecer transaccionar, para que el agente explique el requisito en vez de chocar con un 403 a media frase.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/me/membership' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/food/merchants

Beta Compatible con sandbox

Encuentra restaurantes, supermercados y tiendas abiertos cerca de un punto.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/food/merchants' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/food/merchants/{merchant_id}/menu

Beta Compatible con sandbox

El catálogo público de un comercio. El costo, el inventario, los códigos de barras y los identificadores de proveedor son asunto del comercio y nunca se devuelven aquí.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/food/merchants/$merchant_id/menu' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/food/orders/quote

Beta Compatible con sandbox

Cotiza una canasta exactamente como lo haría el checkout: artículos, cargos, impuestos, cualquier descuento de miembro y el total. Devuelve el quote_id que requiere place_food_order.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/food/orders/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/food/orders

Beta Requiere Ryde One Compatible con sandbox

Realiza el pedido que el cliente confirmó, a partir de un quote_id que se le mostró.

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/food/orders' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/food/orders/{order_id}

Beta Compatible con sandbox

Estado en vivo de un pedido, incluido el avance del mensajero. Deliberadamente SIN restricción de membresía: un pedido que existe sigue siendo rastreable.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/food/orders/$order_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/food/orders

Beta Compatible con sandbox

El historial de pedidos del propio cliente, del más reciente al más antiguo.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/food/orders' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/food/orders/{order_id}/cancel

Beta Compatible con sandbox

Cancela un pedido, cuando su estado actual aún lo permite. Nunca restringido por membresía: SALIR de una transacción no debe requerir un derecho.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/food/orders/$order_id/cancel' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/rides/products

Beta Compatible con sandbox

Las categorías de vehículo que se pueden solicitar, con la tarifa base de cada una.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/rides/products' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/rides/quote

Beta Compatible con sandbox

Distancia por carretera, tiempo de conducción y la tarifa final por categoría de vehículo, impuestos incluidos. Devuelve el quote_id que requiere request_ride.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/rides/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/rides

Beta Requiere Ryde One Compatible con sandbox

Solicita el viaje que el cliente confirmó, a partir de un quote_id que se le mostró.

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/rides' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/rides/{ride_id}

Beta Compatible con sandbox

Estado en vivo de un viaje: avance del despacho, el conductor y vehículo asignados, y el tiempo estimado de llegada. Nunca restringido por membresía: un viaje en curso sigue siendo rastreable.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/rides/$ride_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/rides

Beta Compatible con sandbox

El historial de viajes del propio cliente, del más reciente al más antiguo.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/rides' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/rides/{ride_id}/cancel

Beta Compatible con sandbox

Cancela un viaje que no ha comenzado. Nunca restringido por membresía, por la misma razón que cancelar un pedido.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/rides/$ride_id/cancel' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/deliveries/quote

Beta Compatible con sandbox

Cotiza un envío de mensajería entre dos puntos. Usa la misma ruta de precios que la solicitud, así que la cotización es el cobro.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/deliveries/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/deliveries

Beta Requiere Ryde One Compatible con sandbox

Despacha un mensajero para mover un paquete, a partir de un quote_id que se mostró al cliente.

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/deliveries' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/deliveries/{delivery_id}

Beta Compatible con sandbox

Estado en vivo de una entrega, incluido el avance del mensajero y la prueba de entrega una vez recogida.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/deliveries/$delivery_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/coverage

Beta Requiere acuerdo de transporte Compatible con sandbox

Consulta si Ryde entrega en un código postal o un punto, y con qué niveles de servicio.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/coverage' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/rates

Beta Requiere acuerdo de transporte Compatible con sandbox

Cotiza un paquete a una dirección con tu tarifa contratada, por nivel de servicio. No crea nada.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/rates' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/shipments

Beta Requiere acuerdo de transporte Compatible con sandbox

Entrega a Ryde un paquete para repartir. Devuelve su número de rastreo de Ryde.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/shipments' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/shipments/batch

Beta Requiere acuerdo de transporte Compatible con sandbox

Entrega a Ryde un manifiesto de hasta 500 paquetes en una sola solicitud. Cada fila informa creado, duplicado o rechazado con su motivo.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/shipments/batch' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/shipments/{tracking_number}

Beta Requiere acuerdo de transporte Compatible con sandbox

El estado actual de un paquete, con su historial de escaneos y la prueba de entrega una vez entregado.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/shipments/$tracking_number' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/shipments

Beta Requiere acuerdo de transporte Compatible con sandbox

Tus paquetes, del más reciente al más antiguo, filtrables por estado y fecha.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/shipments' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/shipments/{tracking_number}/cancel

Beta Requiere acuerdo de transporte Compatible con sandbox

Cancela un paquete que entregaste a Ryde, en cualquier momento antes de que se entregue o se devuelva.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/shipments/$tracking_number/cancel' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/shipments/{tracking_number}/events

Beta Requiere acuerdo de transporte Compatible con sandbox

Todos los eventos registrados de un paquete, del más antiguo al más reciente: dónde se escaneó, cuándo y por qué falló un intento.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/shipments/$tracking_number/events' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/hubs

Beta Requiere acuerdo de transporte Compatible con sandbox

Los depósitos desde donde se recogen tus paquetes.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/hubs' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/services/providers

Beta Compatible con sandbox

Encuentra proveedores que se desplazan al cliente, con su disponibilidad en vivo. La disponibilidad se deriva por solicitud y el cliente nunca debe guardarla en caché.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/services/providers' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/services/providers/{provider_id}/slots

Beta Compatible con sandbox

Franjas de cita libres en una fecha, para un trabajo de cierta duración. A un trabajo largo solo se le ofrece un inicio cuyas franjas consecutivas estén todas libres.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/services/providers/$provider_id/slots' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/services/bookings/quote

Beta Compatible con sandbox

Cotiza una reserva de servicio antes de comprometer una franja.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/services/bookings/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/services/bookings

Beta Requiere Ryde One Compatible con sandbox

Reserva un proveedor, opcionalmente en una franja concreta. La competencia por una franja la resuelve la plataforma: una reserva perdedora se rechaza, nunca se duplica.

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/services/bookings' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/services/bookings/{booking_id}

Beta Compatible con sandbox

Estado en vivo de una reserva, desde la llegada hasta el inicio y la finalización.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/services/bookings/$booking_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/tasks/types

Beta Compatible con sandbox

Los tipos de tarea que este mercado puede ejecutar realmente, con la evidencia que recoge cada uno. Solo se listan los tipos que Ryde puede cubrir con personal.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/tasks/types' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/tasks/quote

Beta Compatible con sandbox

Cotiza una tarea y confirma que podría encontrarse un proveedor calificado antes de comprometerse.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/tasks/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/tasks

Beta Requiere Ryde One Compatible con sandbox

Despacha trabajo del mundo real con requisitos estructurados y reglas de evidencia.

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/tasks' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/tasks/{task_id}

Beta Compatible con sandbox

Estado de la tarea, el proveedor asignado y la evidencia recogida hasta el momento.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/tasks/$task_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/tasks/{task_id}/evidence

Beta Compatible con sandbox

La evidencia recogida para una tarea: fotos con sus hashes de contenido, GPS de captura, marcas de tiempo del dispositivo y las respuestas de cualquier lista de verificación.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/tasks/$task_id/evidence' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/tasks/{task_id}/cancel

Beta Compatible con sandbox

Cancela una tarea que no ha comenzado.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/tasks/$task_id/cancel' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/business/orders

Beta Requiere acuerdo comercial Compatible con sandbox

Lista los pedidos de la tienda, del mas reciente al mas antiguo. Filtra por estado o tipo de entrega.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/business/orders' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/business/orders/{order_id}

Beta Requiere acuerdo comercial Compatible con sandbox

Consulta un pedido de la tienda en detalle, con sus articulos y su historial de estados.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/business/orders/$order_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/business/orders/{order_id}/accept

Beta Requiere acuerdo comercial Compatible con sandbox

Acepta un pedido entrante. Se rechaza con 402 si un pedido con tarjeta o billetera aun no esta pagado.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/business/orders/$order_id/accept' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/business/orders/{order_id}/reject

Beta Requiere acuerdo comercial Compatible con sandbox

Rechaza un pedido. Un pedido pagado se reembolsa a la billetera Ryde del cliente — o, si la tienda lo cobró en su propia cuenta de Stripe, a la tarjeta del cliente por la tienda — y se libera la cita reservada.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/business/orders/$order_id/reject' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/business/orders/{order_id}/preparing

Beta Requiere acuerdo comercial Compatible con sandbox

Marca un pedido aceptado como en preparacion, para que el seguimiento del cliente lo refleje.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/business/orders/$order_id/preparing' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/business/orders/{order_id}/ready

Beta Requiere acuerdo comercial Compatible con sandbox

Marca un pedido como listo para recoger. En un pedido a domicilio esto despacha un mensajero de Ryde.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/business/orders/$order_id/ready' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/business/orders/{order_id}/complete

Beta Requiere acuerdo comercial Compatible con sandbox

Completa un pedido para recoger o en el local. Se rechaza con 409 si la cuenta de la mesa sigue abierta.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/business/orders/$order_id/complete' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/business/catalog/items

Beta Requiere acuerdo comercial Compatible con sandbox

Lista los articulos del catalogo de la tienda con precios, modificadores y disponibilidad.

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/business/catalog/items' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/business/catalog/items

Beta Requiere acuerdo comercial Compatible con sandbox

Crea un articulo del catalogo. Aparece de inmediato en el POS de la tienda y en su tienda Ryde.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/business/catalog/items' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

PUT /v1/business/catalog/items/{item_id}

Beta Requiere acuerdo comercial Compatible con sandbox

Actualiza el nombre, la descripcion, el precio, la categoria o los modificadores de un articulo.

Solicitud de ejemplo

curl -sX PUT 'https://sandbox-api.ryde.us.com/v1/business/catalog/items/$item_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

PUT /v1/business/catalog/items/{item_id}/availability

Beta Requiere acuerdo comercial Compatible con sandbox

Retira un articulo de la venta o vuelve a ofrecerlo, sin eliminarlo. La forma reversible de agotarlo.

Solicitud de ejemplo

curl -sX PUT 'https://sandbox-api.ryde.us.com/v1/business/catalog/items/$item_id/availability' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

DELETE /v1/business/catalog/items/{item_id}

Beta Requiere acuerdo comercial Compatible con sandbox

Elimina un articulo del catalogo. No hay forma de deshacerlo por la API; para retirarlo temporalmente, cambia su disponibilidad.

Solicitud de ejemplo

curl -sX DELETE 'https://sandbox-api.ryde.us.com/v1/business/catalog/items/$item_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/business/catalog/items/batch

Beta Requiere acuerdo comercial Compatible con sandbox

Crea varios articulos del catalogo a la vez, con sus categorias. Solo crea: nunca cambia el precio de un articulo existente.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/business/catalog/items/batch' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'