Contenido de la guia
EL API de Rappi incluye todos los recursos, puntos finales y métodos que le permiten integrarse con la aplicación Rappi, asi como manejar todos sus productos, menus, ordenes, horarios de menus, disponibilidad de productos.
API Endpoints
La tabla siguiente contiene todos los recursos disponibles de nuestra API:
Recurso API | Endpoint | Descripción del Endpoint | |
---|---|---|---|
Authentication | POST /restaurants/auth/v1/token/login/integrations | Utilice este punto final para generar un token de acceso para los servicios de integración | NUEVO |
Menús | GET menu | Devuelve la colección de menús creados por el aliado autenticado | |
POST menu | Añade o actualiza un menú en una tienda | ||
GET menu/approved/{storeId} | Devuelve el estado de aprobación actual de un menú | ||
GET menu/rappi/{storeId} | Devuelve el ultimo menú creado para una tienda | ||
PATCH /restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock | Gestiona de forma asincrónica la disponibilidad de productos por SKU o ID en la app de Rappi | NUEVO | |
POST /restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock/status | Devuelve la disponibilidad de productos por SKU o ID en la app de Rappi | NUEVO | |
PATCH /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock | Gestiona de forma asincrónica la disponibilidad de toppings por SKU o ID en la app de Rappi | NUEVO | |
POST /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock/status | Devuelve la disponibilidad de toppings por SKU o ID en la app de Rappi | NUEVO | |
PATCH /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock | Gestiona de forma asincrónica la disponibilidad de productos y toppings por SKU o ID en la app de Rappi | NUEVO | |
POST /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock/status | Devuelve la disponibilidad de productos y toppings por SKU o ID en la app de Rappi | NUEVO | |
Órdenes | GET orders | Devuelve una lista de nuevas ordenes creadas | |
GET orders/status/sent | Devuelve una lista de nuevas ordenes creadas en estado SENT | ||
PUT orders/{orderId}/take/{cookingTime} | Toma una orden para ser preparada | ||
PUT orders/{orderId}/reject | Rechaza una orden | ||
POST orders/{orderId}/ready-for-pickup | Confirma que la orden esta lista para ser recogida | ||
GET orders/{orderId}/events | Devuelve los ultimos eventos de las ordenes | ||
GET restaurants/orders/v1/stores/{storeId}/orders/{orderId}/handoff | Utilice este punto final para tomar un pedido para que la tienda pueda comenzar a prepararlo. | NUEVO | |
POST restaurants/orders/v1/stores/{storeId}/orders/{orderId}/bag-drink-confirmation | Utilice este punto final para confirmar la cantidad de bolsas y si hay bebidas fuera de las bolsas en el pedido. | NUEVO | |
Tiendas | GET stores-pa | Devuelve la lista de tiendas del cliente autenticado | |
PUT stores-pa/{storeId}/status | Actualiza una tienda a integrada o no integrada | ||
POST availability/items/rappi/status | Controla la disponibilidad de los articulos en la aplicación por su ID | ||
PUT availability/stores/items | Controla la disponibilidad de los articulos en la aplicación por su SKU | ||
PUT availability/stores/items/rappi | Controla la disponibilidad de los articulos en la aplicación por su ID | ||
PUT availability/stores | Controla la disponibilidad de la tienda en la aplicación | ||
PUT availability/stores/enable/massive | Maneja de forma asincrónica la disponibilidad de la tienda en la app de Rappi | ||
PUT availability/stores/enable | Maneja de forma sincrónica la disponibilidad de la tienda en la app de Rapppi | ||
PATCH restaurants/menu/v1/stores/{STORE_ID}/products/{IDENTITY_TYPE}/stock | Maneja de forma asincrónica la disponibilidad de los productos por SKU o por ID en la app de Rappi | NUEVO | |
PATCH restaurants/menu/v1/stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stock | Maneja de forma asincrónica la disponibilidad de los toppings por SKU o por ID en la app de Rappi | NUEVO | |
PATCH restaurants/menu/v1/stores/{STORE_ID}/items/{IDENTITY_TYPE}/stock | Maneja de forma asincrónica la disponibilidad de los productos y toppings por SKU o por ID en la app de Rappi | NUEVO | |
Webhooks | GET webhook/{event} | Regresa los Webhooks configurados de todas las tiendas del cliente autenticado | |
PUT webhook/{event}/add-stores | Agrega tiendas al evento del webhook especificado | ||
PUT webhook/{event}/change-url | Cambia la url para una lista de stores | ||
POST webhook | Crea un nuevo Webhook para una lista de tiendas del cliente autenticado | ||
DELETE webhook/{event}/remove-stores | Elimina stores del webhook especificado | ||
PUT webhook/{event}/reset-secret | Reinicia el secret y genera uno nuevo al cliente autenticado | ||
PUT webhook/{event}/change-status | Habilita o deshabilita Webhooks para una lista de tiendas |
Utils Endpoints
Las siguientes tablas contienen todos los recursos disponibles para usar con Utils API:
Dominios
Al realizar solicitudes de API, el sistema requiere que especifique el dominio de su país.
La siguiente tabla contiene todos los dominios de países utilizados para realizar solicitudes de API:
Pais | Dominios |
---|---|
Development | https://microservices.dev.rappi.com |
Uruguay | https://services.rappi.com.uy |
Costa Rica | https://services.rappi.co.cr |
Ecuador | https://services.rappi.com.ec |
Chile | https://services.rappi.cl |
Peru | https://services.rappi.pe |
Argentina | https://services.rappi.com.ar |
Brazil | https://services.rappi.com.br |
Colombia | https://services.rappi.com |
Mexico | https://services.mxgrability.rappi.com |
Nuevos Dominios
La siguiente tabla contiene todos los dominios de países utilizados para realizar solicitudes para la nueva API:
Pais | Dominios |
---|---|
Development | https://api.dev.rappi.com |
Uruguay | https://api.rappi.com.uy |
Costa Rica | https://api.rappi.co.cr |
Ecuador | https://api.rappi.com.ec |
Chile | https://api.rappi.cl |
Peru | https://api.rappi.pe |
Argentina | https://api.rappi.com.ar |
Brazil | https://api.rappi.com.br |
Colombia | https://api.rappi.com.co |
Mexico | https://api.rappi.com.mx |