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 APIEndpointDescripción del Endpoint
AuthenticationPOST /restaurants/auth/v1/token/login/integrationsUtilice este punto final para generar un token de acceso para los servicios de integraciónNUEVO
MenúsGET menuDevuelve la colección de menús creados por el aliado autenticado
POST menuAñ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}/stockGestiona de forma asincrónica la disponibilidad de productos por SKU o ID en la app de RappiNUEVO
POST /restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock/statusDevuelve la disponibilidad de productos por SKU o ID en la app de RappiNUEVO
PATCH /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stockGestiona de forma asincrónica la disponibilidad de toppings por SKU o ID en la app de RappiNUEVO
POST /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock/statusDevuelve la disponibilidad de toppings por SKU o ID en la app de RappiNUEVO
PATCH /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stockGestiona de forma asincrónica la disponibilidad de productos y toppings por SKU o ID en la app de RappiNUEVO
POST /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock/statusDevuelve la disponibilidad de productos y toppings por SKU o ID en la app de RappiNUEVO
ÓrdenesGET ordersDevuelve una lista de nuevas ordenes creadas
GET orders/status/sentDevuelve una lista de nuevas ordenes creadas en estado SENT
PUT orders/{orderId}/take/{cookingTime}Toma una orden para ser preparada
PUT orders/{orderId}/rejectRechaza una orden
POST orders/{orderId}/ready-for-pickupConfirma que la orden esta lista para ser recogida
GET orders/{orderId}/eventsDevuelve los ultimos eventos de las ordenes
GET restaurants/orders/v1/stores/{storeId}/orders/{orderId}/handoffUtilice 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-confirmationUtilice este punto final para confirmar la cantidad de bolsas y si hay bebidas fuera de las bolsas en el pedido.NUEVO
TiendasGET stores-paDevuelve la lista de tiendas del cliente autenticado
PUT stores-pa/{storeId}/statusActualiza una tienda a integrada o no integrada
POST availability/items/rappi/statusControla la disponibilidad de los articulos en la aplicación por su ID
PUT availability/stores/itemsControla la disponibilidad de los articulos en la aplicación por su SKU
PUT availability/stores/items/rappiControla la disponibilidad de los articulos en la aplicación por su ID
PUT availability/storesControla la disponibilidad de la tienda en la aplicación
PUT availability/stores/enable/massiveManeja de forma asincrónica la disponibilidad de la tienda en la app de Rappi
PUT availability/stores/enableManeja de forma sincrónica la disponibilidad de la tienda en la app de Rapppi
PATCH restaurants/menu/v1/stores/{STORE_ID}/products/{IDENTITY_TYPE}/stockManeja de forma asincrónica la disponibilidad de los productos por SKU o por ID en la app de RappiNUEVO
PATCH restaurants/menu/v1/stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stockManeja de forma asincrónica la disponibilidad de los toppings por SKU o por ID en la app de RappiNUEVO
PATCH restaurants/menu/v1/stores/{STORE_ID}/items/{IDENTITY_TYPE}/stockManeja de forma asincrónica la disponibilidad de los productos y toppings por SKU o por ID en la app de RappiNUEVO
WebhooksGET webhook/{event}Regresa los Webhooks configurados de todas las tiendas del cliente autenticado
PUT webhook/{event}/add-storesAgrega tiendas al evento del webhook especificado
PUT webhook/{event}/change-urlCambia la url para una lista de stores
POST webhookCrea un nuevo Webhook para una lista de tiendas del cliente autenticado
DELETE webhook/{event}/remove-storesElimina stores del webhook especificado
PUT webhook/{event}/reset-secretReinicia el secret y genera uno nuevo al cliente autenticado
PUT webhook/{event}/change-statusHabilita o deshabilita Webhooks para una lista de tiendas

Utils Endpoints

Las siguientes tablas contienen todos los recursos disponibles para usar con Utils API:

API ResourceEndpointEndpoint Description
AuthenticationPOST /restaurants/auth/v1/token/login/utilsUtilice este punto final para generar un token de acceso para los servicios de utilidadesNUEVO
Horarios de corredores por tiendaGET corridor/store/{storeId}Retorna la lista de los corredores de la tienda
GET corridor/schedule/{corridorId}/store/{storeId}Retorna los horarios del corredor configurado en la tienda
POST corridor/schedule/{corridorId}/store/{storeId}Crea los horarios del corredor en la tienda
PUT corridor/schedule/{corridorId}/store/{storeId}Actualiza los horarios del corredor en la tienda
DELETE corridor/schedule/{corridorId}/store/{storeId}/{corridorProductScheduleId}Elimina los horarios del corredor en la tienda
Horarios de corredores por integraciónGET corridor/integration/{integrationId}Retorna de los corredores de la tienda
GET corridor/schedule/{corridorId}/integration/{integrationId}Retorna los horarios del corredor configurado en la tienda
POST corridor/schedule/{corridorId}/integration/{integrationId}Crea los horarios del corredor en la tienda
PUT corridor/schedule/{corridorId}/integration/{integrationId}Actualiza los horarios del corredor en la tienda
DELETE corridor/schedule/{corridorId}/integration/{integrationId}/{corridorProductScheduleId}Elimina los horarios del corredor en la tienda
Horarios de productos por IDGET product/corridor/{corridorId}/store/{storeId}Retorna la lista de producto por corredor y por tienda
GET product/schedule/{productId}/corridor/{corridorId}/store/{storeId}Retorna los horarios del producto configurado en la tienda
POST product/schedule/{productId}/corridor/{corridorId}/store/{storeId}Crea los horarios del producto asociados al corredor y la tienda
PUT product/schedule/{productId}/corridor/{corridorId}/store/{storeId}Actualiza los horarios del producto asociados al corredor y la tienda
DELETE product/schedule/{productId}/corridor/{corridorId}/store/{storeId}/{corridorProductScheduleId}Elimina los horarios del producto asociados al corredor y la tienda
Horarios de productos por SKUGET sku/corridor/{corridorId}/integration/{integrationId}Retorna la lista de producto por corredor y por tienda
GET sku/schedule/{sku}/corridor/{corridorId}/integration/{integrationId}Retorna los horarios del producto configurado en la tienda
POST sku/schedule/{sku}/corridor/{corridorId}/integration/{integrationId}Crea los horarios del producto asociados al corredor y la tienda
PUT sku/schedule/{sku}/corridor/{corridorId}/integration/{integrationId}Actualiza los horarios del producto asociados al corredor y la tienda
DELETE sku/schedule/{sku}/corridor/{corridorId}/integration/{integrationId}/{corridorProductScheduleId}Elimina los horarios del producto asociados al corredor y la tienda
Horarios de las tiendasGET store/schedule/{storeId}Retorna todo el horario regular de la tienda
GET store/schedule/{storeId}/holidayRetorna todo el horario de dias festivos
GET store/schedule/{storeId}/specialRetorna todo el horario de dias especiales de la tienda
POST store/schedule/{storeId}Crea una franja horaria en un día de horario regular de la tienda
POST store/schedule/{storeId}/holiday/{holidayDayId}Crea una franja horaria en un día feriado
POST store/schedule/{storeId}/specialCrea un día especial de la tienda
POST store/schedule/{storeId}/special/{specialDayId}Crea una franja horaria en un día especial de la tienda
PUT store/schedule/{storeId}/{storeScheduleId}Actualiza una franja horaria
DELETE store/schedule/{storeId}/{storeScheduleId}Elimina una franja horaria
DELETE store/schedule/{storeId}/special/{specialDayId}Elimina un dia especial
Estado de productosGET menu/integration/{integrationId}Retorna la lista de productos y toppings mostrando el estado de los items y su disponibilidad.

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:

PaisDominios
Developmenthttps://microservices.dev.rappi.com
Uruguayhttps://services.rappi.com.uy
Costa Ricahttps://services.rappi.co.cr
Ecuadorhttps://services.rappi.com.ec
Chilehttps://services.rappi.cl
Peruhttps://services.rappi.pe
Argentinahttps://services.rappi.com.ar
Brazilhttps://services.rappi.com.br
Colombiahttps://services.rappi.com
Mexicohttps://services.mxgrability.rappi.com

Nuevos Dominios

La siguiente tabla contiene todos los dominios de países utilizados para realizar solicitudes para la nueva API:

PaisDominios
Developmenthttps://api.dev.rappi.com
Uruguayhttps://api.rappi.com.uy
Costa Ricahttps://api.rappi.co.cr
Ecuadorhttps://api.rappi.com.ec
Chilehttps://api.rappi.cl
Peruhttps://api.rappi.pe
Argentinahttps://api.rappi.com.ar
Brazilhttps://api.rappi.com.br
Colombiahttps://api.rappi.com.co
Mexicohttps://api.rappi.com.mx