Ir al contenido

Ryde Developers

English Panel ryde.us.com

Comercio

Opera una tienda para la que tienes autorización: consulta y gestiona su cola de pedidos y administra su catálogo. Son las mismas rutas que usan el portal de comercios de Ryde y su punto de venta, así que un cambio hecho aquí aparece de inmediato en el terminal de la tienda: no existe un "catálogo de API" aparte que haya que sincronizar. El acceso requiere la autorización del propio comercio y su acuerdo comercial de Ryde firmado; un desarrollador no puede aceptar ese acuerdo en nombre de una tienda.

Versión de la API v1 · Ver como Markdown

Opera una tienda para la que tienes autorización: consulta y gestiona su cola de pedidos y administra su catálogo. Son las mismas rutas que usan el portal de comercios de Ryde y su punto de venta, así que un cambio hecho aquí aparece de inmediato en el terminal de la tienda: no existe un "catálogo de API" aparte que haya que sincronizar. El acceso requiere la autorización del propio comercio y su acuerdo comercial de Ryde firmado; un desarrollador no puede aceptar ese acuerdo en nombre de una tienda.

Ciclo de vida

  PLACED                (the customer has paid, or is paying cash)
     |
  MERCHANT ACCEPTED  ---> REJECTED   (a paid order is refunded to the
     |                                customer's Ryde wallet)
  PREPARING
     |
  READY FOR PICKUP      (for a delivery order, THIS is what dispatches
     |                   a Ryde courier — couriers accept first-come,
     |                   so there is nothing to assign)
  PICKED UP
     |
  DELIVERED             (or COMPLETED, for pickup and dine-in)

Operaciones

`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.

Operación	`list_business_orders`
Alcance	`orders.read`
Derecho	Requiere acuerdo comercial
Idempotencia	No requerida
Herramienta MCP	`list_business_orders`

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.

Operación	`get_business_order`
Alcance	`orders.read`
Derecho	Requiere acuerdo comercial
Idempotencia	No requerida
Herramienta MCP	`get_business_order`

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.

Operación	`accept_business_order`
Alcance	`orders.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`accept_business_order`

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.

Operación	`reject_business_order`
Alcance	`orders.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`reject_business_order`

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.

Operación	`start_business_order_prep`
Alcance	`orders.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`start_business_order_prep`

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.

Operación	`mark_business_order_ready`
Alcance	`orders.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`mark_business_order_ready`

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.

Operación	`complete_business_order`
Alcance	`orders.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`complete_business_order`

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.

Operación	`list_catalog_items`
Alcance	`menu.read`
Derecho	Requiere acuerdo comercial
Idempotencia	No requerida
Herramienta MCP	`list_catalog_items`

Solicitud de ejemplo

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

`GET` `/v1/business/catalog/items/{item_id}`

Beta Requiere acuerdo comercial Compatible con sandbox

Lee un articulo del catalogo por su id: precio, SKU, codigo de barras, impuesto, existencia y disponibilidad.

Operación	`get_catalog_item`
Alcance	`menu.read`
Derecho	Requiere acuerdo comercial
Idempotencia	No requerida
Herramienta MCP	`get_catalog_item`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/business/catalog/items/$item_id' \
  -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.

Operación	`create_catalog_item`
Alcance	`menu.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`create_catalog_item`

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.

Operación	`update_catalog_item`
Alcance	`menu.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`update_catalog_item`

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/by-sku/{sku}`

Beta Requiere acuerdo comercial Compatible con sandbox

Crea o actualiza el articulo del catalogo con este SKU. El SKU es unico en la tienda, asi que la misma llamada se puede repetir sin riesgo.

Operación	`upsert_catalog_item_by_sku`
Alcance	`menu.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`upsert_catalog_item_by_sku`

Solicitud de ejemplo

curl -sX PUT 'https://sandbox-api.ryde.us.com/v1/business/catalog/items/by-sku/$sku' \
  -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.

Operación	`set_catalog_item_availability`
Alcance	`menu.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`set_catalog_item_availability`

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.

Operación	`delete_catalog_item`
Alcance	`menu.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`delete_catalog_item`

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

Agrega varios articulos del catalogo a la vez, con sus categorias. Sin duplicados: un articulo que coincide por SKU o codigo de barras se actualiza (precio y descripcion) en vez de agregarse dos veces, una coincidencia solo por nombre se omite salvo que se decida, y el modo "replace" retira los articulos que no estan en la lista cuando confirm_retire es igual al conteo que indica un 409.

Operación	`import_catalog_items`
Alcance	`menu.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`import_catalog_items`

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 '{ … }'

`GET` `/v1/business/catalog/export`

Beta Requiere acuerdo comercial Compatible con sandbox

Exporta el catalogo vendible de la tienda como filas en las columnas de la plantilla fija (nombre, SKU, codigo de barras, categoria, tipo, precio, impuesto, costo, existencia, almacen, descripcion). Costo, existencia y codigo de barras solo se llenan con un token menu.manage.

Operación	`export_catalog`
Alcance	`menu.read`
Derecho	Requiere acuerdo comercial
Idempotencia	No requerida
Herramienta MCP	`export_catalog`

Solicitud de ejemplo

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

`GET` `/v1/business/catalog/template`

Beta Requiere acuerdo comercial Compatible con sandbox

Las columnas de la plantilla, los valores que acepta cada una, una fila de ejemplo, el limite de filas y los modos de importacion.

Operación	`get_catalog_template`
Alcance	`menu.read`
Derecho	Requiere acuerdo comercial
Idempotencia	No requerida
Herramienta MCP	`get_catalog_template`

Solicitud de ejemplo

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

`POST` `/v1/business/catalog/import/preview`

Beta Requiere acuerdo comercial Compatible con sandbox

Revisa filas en las columnas de la plantilla contra el catalogo SIN escribir: que es nuevo, actualizado, sin cambios, posible duplicado o error, por fila. Devuelve un token para confirmar.

Operación	`preview_catalog_import`
Alcance	`menu.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`preview_catalog_import`

Solicitud de ejemplo

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

`POST` `/v1/business/catalog/import/commit`

Beta Requiere acuerdo comercial Compatible con sandbox

Aplica una importacion revisada con su token, en modo merge, add_only o replace. Confirmar el mismo token otra vez devuelve el primer resultado y no escribe nada.

Operación	`commit_catalog_import`
Alcance	`menu.manage`
Derecho	Requiere acuerdo comercial
Idempotencia	Compatible
Herramienta MCP	`commit_catalog_import`

Solicitud de ejemplo

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