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 Resource | Endpoint | Endpoint Description | |
---|---|---|---|
Authentication | POST /restaurants/auth/v1/token/login/integrations | Use this endpoint to generate an access token for integrations services | NEW |
Menus | GET menu | Returns the collection of menus created by the authenticating ally | |
POST menu | Creates 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}/stock | Asynchronously manages the availability of products by SKU or ID in the Rappi app | NEW | |
POST /restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock/status | Returns the availability of products by SKU or ID in the Rappi app | NEW | |
PATCH /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock | Asynchronously manages the availability of toppings by SKU or ID in the Rappi app | NEW | |
POST /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock/status | Returns the availability of toppings by SKU or ID in the Rappi app | NEW | |
PATCH /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock | Asynchronously manages the availability of products and toppings by SKU or ID in the Rappi app | NEW | |
POST /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock/status | Returns the availability of products and toppings by SKU or ID in the Rappi app | NEW | |
Orders | GET orders | Returns a list of new orders created | |
GET orders/status/sent | Returns a list of new orders created in SENT | ||
PUT orders/{orderId}/take/{cookingTime} | Takes an order to start preparing | ||
PUT orders/{orderId}/reject | Rejects an order | ||
POST orders/{orderId}/ready-for-pickup | Confirms that the order is ready for pickup | ||
GET orders/{orderId}/events | Returns the latest events from the orders | ||
GET /restaurants/orders/v1/stores/{storeId}/orders/{orderId}/handoff | Use 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-confirmation | Use this endpoint to confirm the number of bags and if there are drinks outside the bags in the order. | NEW | |
Stores | GET stores-pa | Returns the list of stores for the authenticated client | |
PUT stores-pa/{storeId}/status | Update a store to integrated or not integrated | ||
Availability | POST availability/items/status | Returns the availability of items by Item SKU | |
POST availability/items/rappi/status | Returns the availability of items by Item ID | ||
PUT availability/stores/items | Manage item availability in the application by Item SKU | ||
PUT availability/stores/items/rappi | Manage item availability in the application by Item ID | ||
PUT availability/stores | Manage store availability in the application | ||
PUT availability/stores/enable/massive | Manage store availability asynchronously in the application | ||
PUT availability/stores/enable | Manage store availability synchronously in the application | ||
Webhooks | GET webhook/{event} | Returns the webhooks configured for all the stores of the authenticated client | |
PUT webhook/{event}/add-stores | Add stores to a specific webhook event | ||
PUT webhook/{event}/change-url | Change url from stores | ||
POST webhook | Creates a new webhook for a list of stores for the authenticated client | ||
DELETE webhook/{event}/remove-stores | Deletes stores from your webhook | ||
PUT webhook/{event}/reset-secret | Restarts the secret and generates a new one for the authenticated client | ||
PUT webhook/{event}/change-status | Enables or disables the webhooks for a list of stores |
Utils Endpoints
The following tables contains all the resources available to use with Utils API:
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:
Country | Domain |
---|---|
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 |
New Domains
The following table contains all the country domains used to make requests for the new API:
Country | Domain |
---|---|
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 |