Contents of the guide

The Rappi API includes all the resources, endpoints, and methods that allow you to integrate with the Rappi app, as well as manage all your products, menus, orders, menu schedules, and product availability.

API Endpoints

The following table contains all the resources available to use with our API:

API ResourceEndpointEndpoint Description
AuthenticationPOST /restaurants/auth/v1/token/login/integrationsUse this endpoint to generate an access token for integrations servicesNEW
MenusGET menuReturns the collection of menus created by the authenticating ally
POST menuCreates or updates a menu in a store
GET menu/approved/{storeId}Returns the current approval status of a menu
GET menu/rappi/{storeId}Returns the last menu created for a store
PATCH /restaurants/menu/v1/stores/{storeId}/products/{identityType}/stockAsynchronously manages the availability of products by SKU or ID in the Rappi appNEW
POST /restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock/statusReturns the availability of products by SKU or ID in the Rappi appNEW
PATCH /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stockAsynchronously manages the availability of toppings by SKU or ID in the Rappi appNEW
POST /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock/statusReturns the availability of toppings by SKU or ID in the Rappi appNEW
PATCH /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stockAsynchronously manages the availability of products and toppings by SKU or ID in the Rappi appNEW
POST /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock/statusReturns the availability of products and toppings by SKU or ID in the Rappi appNEW
OrdersGET ordersReturns a list of new orders created
GET orders/status/sentReturns a list of new orders created in SENT
PUT orders/{orderId}/take/{cookingTime}Takes an order to start preparing
PUT orders/{orderId}/rejectRejects an order
POST orders/{orderId}/ready-for-pickupConfirms that the order is ready for pickup
GET orders/{orderId}/eventsReturns the latest events from the orders
GET /restaurants/orders/v1/stores/{storeId}/orders/{orderId}/handoffUse this endpoint to take an order so that the store can start preparing it.NEW
POST /restaurants/orders/v1/stores/{storeId}/orders/{orderId}/bag-drink-confirmationUse this endpoint to confirm the number of bags and if there are drinks outside the bags in the order.NEW
StoresGET stores-paReturns the list of stores for the authenticated client
PUT stores-pa/{storeId}/statusUpdate a store to integrated or not integrated
AvailabilityPOST availability/items/statusReturns the availability of items by Item SKU
POST availability/items/rappi/statusReturns the availability of items by Item ID
PUT availability/stores/itemsManage item availability in the application by Item SKU
PUT availability/stores/items/rappiManage item availability in the application by Item ID
PUT availability/storesManage store availability in the application
PUT availability/stores/enable/massiveManage store availability asynchronously in the application
PUT availability/stores/enableManage store availability synchronously in the application
WebhooksGET webhook/{event}Returns the webhooks configured for all the stores of the authenticated client
PUT webhook/{event}/add-storesAdd stores to a specific webhook event
PUT webhook/{event}/change-urlChange url from stores
POST webhookCreates a new webhook for a list of stores for the authenticated client
DELETE webhook/{event}/remove-storesDeletes stores from your webhook
PUT webhook/{event}/reset-secretRestarts the secret and generates a new one for the authenticated client
PUT webhook/{event}/change-statusEnables or disables the webhooks for a list of stores

Utils Endpoints

The following tables contains all the resources available to use with Utils API:

API ResourceEndpointEndpoint Description
AuthenticationPOST /restaurants/auth/v1/token/login/utilsUse this endpoint to generate an access token for utils servicesNEW
Corridor SchedulesGET corridor/store/{storeId}Returns the collection of corridors for the store
GET corridor/schedule/{corridorId}/store/{storeId}Returns the corridor schedules configured for the store
POST corridor/schedule/{corridorId}/store/{storeId}Create corridor schedules for the store
PUT corridor/schedule/{corridorId}/store/{storeId}Update corridor schedules for the store
DELETE corridor/schedule/{corridorId}/store/{storeId}/{corridorProductScheduleId}Delete corridor schedules for the store
Corridor Schedules by IntegrationGET corridor/integration/{integrationId}Returns the collection of corridors for the store
GET corridor/schedule/{corridorId}/integration/{integrationId}Returns the corridor schedules configured for the store
POST corridor/schedule/{corridorId}/integration/{integrationId}Create corridor schedules for the store
PUT corridor/schedule/{corridorId}/integration/{integrationId}Update corridor schedules for the store
DELETE corridor/schedule/{corridorId}/integration/{integrationId}/{corridorProductScheduleId}Delete corridor schedules for the store
Product SchedulesGET product/corridor/{corridorId}/store/{storeId}Returns the collection of products for the corridor and store
GET product/schedule/{productId}/corridor/{corridorId}/store/{storeId}Returns the product schedules configured for the corridor and store
POST product/schedule/{productId}/corridor/{corridorId}/store/{storeId}Create product schedules for the corridor and store
PUT product/schedule/{productId}/corridor/{corridorId}/store/{storeId}Update product schedules for the corridor and store
DELETE product/schedule/{productId}/corridor/{corridorId}/store/{storeId}/{corridorProductScheduleId}Delete product schedules for the corridor and store
Product Schedules by SKUGET sku/corridor/{corridorId}/integration/{integrationId}Returns the collection of products for the corridor and store
GET sku/schedule/{sku}/corridor/{corridorId}/integration/{integrationId}Returns the product schedules configured for the corridor and store
POST sku/schedule/{sku}/corridor/{corridorId}/integration/{integrationId}Create product schedules for the corridor and store
PUT sku/schedule/{sku}/corridor/{corridorId}/integration/{integrationId}Update product schedules for the corridor and store
DELETE sku/schedule/{sku}/corridor/{corridorId}/integration/{integrationId}/{corridorProductScheduleId}Delete product schedules for the corridor and store
Store hoursGET store/schedule/{storeId}Returns all regular store hours
GET store/schedule/{storeId}/holidayReturns all holiday hours
GET store/schedule/{storeId}/specialReturns all the hours of the store's special days
POST store/schedule/{storeId}Create a time slot on a regular schedule day of the store
POST store/schedule/{storeId}/holiday/{holidayDayId}Create a time slot on a holiday
POST store/schedule/{storeId}/specialCreate a special day for the store
POST store/schedule/{storeId}/special/{specialDayId}Create a time slot on a store's special day
PUT store/schedule/{storeId}/{storeScheduleId}Update a time slot
DELETE store/schedule/{storeId}/{storeScheduleId}Delete a time slot
DELETE store/schedule/{storeId}/special/{specialDayId}Delete a special day
Product StatusGET menu/integration/{integrationId}Return the list of products and toppings with status and their availability

Domains

When making API requests, the system requires you to specify the domain of your country.

The following table contains all the country domains used for making API Requests:

CountryDomain
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

New Domains

The following table contains all the country domains used to make requests for the new API:

CountryDomain
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