
# Getting Started

<a href="/en/api-reference/rests-api/" target="_blank" class="api">API Reference</a>

We are pleased to inform you about an update in our API services involving the implementation of new domains for certain specific endpoints. From now on, some of our API services will be exclusively available through these new domains, while others will continue to function normally with the current domains.

It's important to note that the previous domains will remain operational and will continue to be the access route for the vast majority of our endpoints. However, certain specific services and functionalities will require the use of the new domains for access.

Rappi recommends that you familiarize yourself with the terminology used during the process, authentication methods, and understand the requirements for a successful integration.

## Country 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 URL                 |
| ---------- | -------------------------- |
| Argentina  | `https://api.rappi.com.ar` |
| Brazil     | `https://api.rappi.com.br` |
| Chile      | `https://api.rappi.cl`     |
| Colombia   | `https://api.rappi.com.co` |
| Costa Rica | `https://api.rappi.co.cr`  |
| Ecuador    | `https://api.rappi.com.ec` |
| Mexico     | `https://api.rappi.com.mx` |
| Peru       | `https://api.rappi.pe`     |
| Uruguay    | `https://api.rappi.com.uy` |

For testing purposes, use the Developer domain:

`https://api.dev.rappi.com`

## Rules for using the new Domains

To utilize these domains, it's crucial to adhere to the following rules:

### Common base path

All API calls start with the common base path `/restaurants/{Module Name}`. For example:

- api.rappi.com.co/restaurants/`finance/v1`
- api.rappi.com.mx/restaurants/`finance/v1`

### Authentication token

!!! important
Read information about audiences to have a broader context of what will be mentioned <a href="/en/authentication-process/#audiences" target="_blank">Read Here</a>

!!! important
The audience's {Country domain} marker refers to the following domains <a href="/en/getting-started/#country-domains" target="_blank">Read Here</a>

With the new domains, even though previously different audiences could be used for authentication, now only a single audience in the generated token is allowed. This audience must exclusively be `{Country domain}/api/v2/restaurants-integrations-public-api`.


Rests API

What is an Integration?

Benefits of the Integration

Process Improvements

Portal Overview

Country Domains

Getting Started

Authentication Requirements

Generating an Access Token

Audiences

Using Your Access Token

Authentication Process

Types of mapping

Improvements with automatic menu

Creating a Menu for a Store

Validations on the Received menu

Obtaining Menu Information

Consulting the Approval Status of Your Menus

Retrieving Your Last Created Menu

Managing Store Menus

Order Status

Order Events

Cancelation Events

Order Totals and Discounts

Address Information

Marketplace Fields by Country

Delivery Methods

Order Properties

Retrieving New Orders

Retrieving New Orders Status SENT

Cooking Time - CT

Taking Orders

Rejecting Orders

Notify the Order is Ready for Pickup

Retrieving Order Events

Managing User Orders

Consulting the Availability by SKU

Consulting the Availability by Rappi ID

Setting Availability by SKU

Setting Availability by Rappi ID

Item Availability

Behaviour

HOW DOES PING WORK?

PING RULES

Health Check

Store status

Store Availability (asynchronous)

Store Availability massive (asynchronous)

Store Availability (synchronous)

Managing Availability

Products

Toppings

Topping Category

Menú info

Check-In Code

Retrieving Stores Data

NEW_ORDER

ORDER_EVENT_CANCEL

ORDER_OTHER_EVENT

MENU_APPROVED

MENU_REJECTED

PING

STORE_CONNECTIVITY

ORDER_RT_TRACKING

Webhook event payloads

Security

Validating Your Signature

Webhook Events

Quality Standards

Performance Standards

Requirements

Order Integrations

Integration Standards

Corridor information

Getting corridor schedules

Creating corridor schedules

Updating corridor schedules

Deleting corridor schedules

By store ID

By integration ID

Corridor schedules

Product information

Getting product schedules

Creating product schedules

Updating product schedules

Deleting product schedules

By product

SKU information

By SKU

Product schedules

Regular schedule information

Holidays schedule information

Special days schedule information

Creating time slots for regular hours

Creating time slots for holidays

Creating a special day

Creating time slots for special days

Updating time slots

Deleting time slots

Deleting special days

By store

Store hours

Getting status of the stores menus

Getting status of the store products

Stores status menus

Frequently asked questions about updating schedules

Utils

Appendix - Integration Glossary

Authentication

Orders

Availability

FAQs

Deprecations headers

Total and discounts changes

Deprecations

Common base path

Authentication token

Rules for using the new Domains

Retrieving New Orders From A Specific Store

Taking Orders with specific cooking time

Get QR Code of an Order

Confirm Bags and Drinks

STORE_CLOSED

ITEM_STOCKOUT

POS_OFFLINE

POS_INTERNAL_ERROR

INTEGRATOR_ERROR

DELIVERY_METHOD_NOT_SUPPORTED

ORDER_TOTAL_INCORRECT

ORDER_CHARGES_INCORRECT

ORDER_DISCOUNTS_INCORRECT

OUTSIDE_DELIVERY_AREA

ITEM_PRICE_INCORRECT

ITEM_NOT_FOUND

CUSTOMER_INFO_INCORRECT

List of Accepted Cancellation Types

Managing User Orders of Rests API

Setting Availability of Products by SKU or ID

Setting Availability of Toppings by SKU or ID

Setting Availability of Items by SKU or ID

Managing Availability of Rests API

Financial API operations

Financial

Portal Overview

The purpose of this portal is to provide the Rappi allies with all the documentation related to the Rappi API.

The contents of this site enable you to:

Obtain the required information to integrate the Rappi API with your process.

Understand the terminology used in the API integration procedures.

Learn how to authenticate to integrate with our API.

Access the API Reference to explore the available resources, endpoints, methods, and samples of API requests and responses.

On this site, you can also find step-by-step guides to make API requests to interact with the available resources of the application.

What is an Integration?

An integration with Rappi is a procedure where you incorporate the resources of your business with Rappi.

Using the Rappi API enables you to integrate quickly and easily with the application.

Benefits of the Integration

As a Rappi ally, you and your business can benefit from the Rappi integration.

Rappi enables you to control your interaction with the platform and gives you complete visibility of your available resources in the application.

With this procedure, you are in full control of your stores, menus, items, and the workflow of your orders.

Process Improvements

Integrating with Rappi using our API enables you to improve your process by:

Managing the orders that users make through the Rappi application.

Consulting order changes and information about your stores.

Managing the availability of the items in your stores.

Consulting and managing the menus of your stores.

Configuring Webhooks to receive updates from your stores.

If you need support, please refer to your main Rappi point of contact.


Integrating with Rappi using our API enables you to improve your process by:Configuring Webhooks to receive updates from your stores.Consulting and managing the menus of your stores.Managing the availability of the items in your stores.Consulting order changes and information about your stores.Managing the orders that users make through the Rappi application.If you need support, please refer to your main Rappi point of contact.


As a Rappi ally, you and your business can benefit from the Rappi integration.Rappi enables you to control your interaction with the platform and gives you complete visibility of your available resources in the application.With this procedure, you are in full control of your stores, menus, items, and the workflow of your orders.


An integration with Rappi is a procedure where you incorporate the resources of your business with Rappi.Using the Rappi API enables you to integrate quickly and easily with the application.


The purpose of this portal is to provide the Rappi allies with all the documentation related to the Rappi API.The contents of this site enable you to:.responses and samples of API requests, and methods, endpoints, resources to explore the available API ReferenceAccess the  to integrate with our API.authenticateLearn how to  used in the API integration procedures.terminologyUnderstand the Obtain the required information to integrate the Rappi API with your process.On this site, you can also find step-by-step guides to make API requests to interact with the available resources of the application.


Getting Started

The following sections contain the information that you require to use the Rappi API.

Rappi recommends you to get familiar with the terminology used during the process, the authentication methods, and to know the requirements for a successful integration.

Country 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 URL                               |
| ---------- | ---------------------------------------- |
| Argentina  | https://services.rappi.com.ar          |
| Brazil     | https://services.rappi.com.br          |
| Chile      | https://services.rappi.cl              |
| Colombia   | https://services.rappi.com             |
| Costa Rica | https://services.rappi.co.cr           |
| Ecuador    | https://services.rappi.com.ec          |
| Mexico     | https://services.mxgrability.rappi.com |
| Peru       | https://services.rappi.pe              |
| Uruguay    | https://services.rappi.com.uy          |

For testing purposes, use the Developer domain:

https://microservices.dev.rappi.com


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:          |https://services.rappi.com.uy              |
| Uruguay    | https://services.rappi.pe |
| Peru       | https://services.mxgrability.rappi.com          |
| Mexico     | https://services.rappi.com.ec           |
| Ecuador    | https://services.rappi.co.cr             |
| Costa Rica | https://services.rappi.com              |
| Colombia   | https://services.rappi.cl          |
| Chile      | https://services.rappi.com.br          |
| Brazil     | https://services.rappi.com.ar| Country    | Domain URL                               |
| ---------- | ---------------------------------------- |
| Argentina  | For testing purposes, use the Developer domain:https://microservices.dev.rappi.com


The following sections contain the information that you require to use the Rappi API.Rappi recommends you to get familiar with the terminology used during the process, the authentication methods, and to know the requirements for a successful integration.


Authentication ProcessAPI ReferenceThis section contains all the information that you need to get your API credentials, and guides you through the authentication process to use the Rappi Public API.Authentication RequirementsRappi uses OAuth 2.0 as the authentication method for secure API requests to the Rappi Public API.During the integration process, Rappi grants you your own set of API credentials. With these credentials, you must generate a token to authenticate when making API requests.The API credentials that Rappi gives you consist of the following objects:| Item          | Description                                                               |
| ------------- | ------------------------------------------------------------------------- |
| Client ID     | This is the identifier of the client where you authenticate.              |
| Client Secret | This is the secret that you require to authenticate for your integration. |
| Audience      | This is the identifiers of the Rappi API.                                 |
| Grant Type    | This is permission to request.                                            |!!! important
Depending on the API you use, the audience will change and you will have to generate a token to use itGenerating an Access TokenAPI ReferenceGenerate an access token through an API call using the POST token endpoint.!!! important
Your access token has a validity of 1 week. After this time, you must generate a new token to continue making requests to our secured endpoint.To generate your token:Make a POST request to one of the following URLs, and add a JSON to the body of the request with the following object.URL: https://{NEW\_DOMAIN}/restaurants/auth/oauth/token{NEW\_DOMAIN}: This is your new Rappi Country Domain. See the list of new Country Domains.The following code sample the structure of the JSON object in the body of the request:{OLD\_DOMAIN}: This is your old Rappi Country Domain. See the list of old Country Domains.!!! note
The values from this JSON are not real data. Ensure to replace them with your own data when making API requests.The following table describes the values of the request body attributes:| Attributes                  | Requirement | Description                              |
| --------------------------- | ----------- | ---------------------------------------- |
| client\_idstring     | required  | Client Id of your Rappi Credentials.     |
| client\_secretstring | required  | Client Secret of your Rappi Credentials. |
| audiencestring      | required  | Identifier of the Rappi API.             |
| grant\_typestring    | required  | Permission to request.                   |The system responds with your access\_token.Now that you have your token, you can start integrating with the Rappi Public API.Audiences| API Audience  | Value                                                     |
| ------------- | --------------------------------------------------------- |
| Public Api V2 | {OLD\_DOMAIN}/api/v2/restaurants-integrations-public-api |
| Utils         | https://rest-ops-utils/api                              |{OLD\_DOMAIN}: This is your old Rappi Country Domain. See the list of old Country Domains.Using Your Access TokenTo authenticate using your access token when making API requests:Include your access token in a custom header of your request with the following values:| Key               | Value                       |
| ----------------- | --------------------------- |
| x-authorization | Bearer \[{access\_token}] |{access\_token}: This is your generated access token.Ensure to include these values in the header of all your API requests for a successful authentication.


To authenticate using your access token when making API requests:Include your access token in a custom header of your request with the following values:] |{access\_token} \[Bearer | x-authorization| Key               | Value                       |
| ----------------- | --------------------------- |
| }: This is your generated access token.access\_token{Ensure to include these values in the header of all your API requests for a successful authentication.


| Utils         | {OLD\_DOMAIN}/api/v2/restaurants-integrations-public-api| API Audience  | Value                                                     |
| ------------- | --------------------------------------------------------- |
| Public Api V2 | .See the list of old Country Domains: This is your old Rappi Country Domain. {OLD\_DOMAIN}


API Reference endpoint.POST tokenGenerate an access token through an API call using the . After this time, you must generate a new token to continue making requests to our secured endpoint.1 week!!! important
Your access token has a validity of To generate your token: to the body of the request with the following object.JSON request to one of the following URLs, and add a POSTMake a https://{NEW\_DOMAIN}/restaurants/auth/oauth/token: URL.See the list of new Country Domains: This is your new Rappi Country Domain. {NEW\_DOMAIN} object in the body of the request:JSONThe following code sample the structure of the {
"client\_id": "7iCfjZCO4bTns3OjqLK4de2GV3sp6Ymd",
"client\_secret": "40iFFYJV9A1LrVmJsaIeARW40iFFYJV9A1LrVmJsaIeARW40iFFYJV9A1LrVmJsaIeARW",
"audience": "{OLD\_DOMAIN}/api/v2/restaurants-integrations-public-api",
"grant\_type": "client\_credentials"
}.See the list of old Country Domains: This is your old Rappi Country Domain. {OLD\_DOMAIN} are not real data. Ensure to replace them with your own data when making API requests.JSON!!! note
The values from this The following table describes the values of the request body attributes:  | Permission to request.                   |required    | stringgrant\_type  | Identifier of the Rappi API.             |
| required      | stringaudience  | Client Secret of your Rappi Credentials. |
| required | stringclient\_secret  | Client Id of your Rappi Credentials.     |
| required     | stringclient\_id| Attributes                  | Requirement | Description                              |
| --------------------------- | ----------- | ---------------------------------------- |
| .access\_tokenThe system responds with your Now that you have your token, you can start integrating with the Rappi Public API.


as the authentication method for secure API requests to the Rappi Public API.OAuth 2.0Rappi uses During the integration process, Rappi grants you your own set of API credentials. With these credentials, you must generate a token to authenticate when making API requests.The API credentials that Rappi gives you consist of the following objects:| Item          | Description                                                               |
| ------------- | ------------------------------------------------------------------------- |
| Client ID     | This is the identifier of the client where you authenticate.              |
| Client Secret | This is the secret that you require to authenticate for your integration. |
| Audience      | This is the identifiers of the Rappi API.                                 |
| Grant Type    | This is permission to request.                                            |!!! important
Depending on the API you use, the audience will change and you will have to generate a token to use it


API ReferenceThis section contains all the information that you need to get your API credentials, and guides you through the authentication process to use the Rappi Public API.


Managing Store MenusAPI ReferenceThe Rappi API enables you to manage the menus of your stores.You can create and update menus in the platform, retrieve the items of the menus, and review the approval status of your requests to create or update menus.The main properties of the menus and the items created through the Rappi API consist of the following items:storeId: The store identifieritems: The items in the menucategory: The category of the items in the menuid: The SKU (Stock-Keeping Unit) the ally gives to this categorymaxQty: The maximum number of items that can be ordered in this categoryminQty: The minimum quantity of elements that can be ordered in this category (In toppings, if it's 0 it means that it's not mandatory)name: Category namesortingPosition: If it's a product category, it's the position of the category in the menu. In case of being a Topping category, it's the position of the category within the productchildren: Subitems nested in a categoryname: The name of the item in the menudescription: The description of the item in the menuimageUrl: The url of the image of the item in the menuprice: The price of the item in the menurappiIds: The identifier Rappi gives to this itemsku: The SKU (Stock-Keeping Unit) the ally gives to this itemsortingPosition: The position of the item in its categorytype: The type of the itemmaxLimit: Maximum indicator of the item, it's required only if the type is toppingcombo: Indicates if the element belongs to a combo. (if it is true it means that it belongs to a combo)Some of these properties are subdivided into more objects. For a detailed view and a deeper explanation of these items, consult the Menus API resource on the Rappi API Reference.Types of mappingNo mapping: The ally loads their menu from the partners portal, without placing the SKUs of the menu items. Upon receiving an order, the json of the order will have the Rappi ids of the items but their SKUs will be null, so the ally is in charge of downloading their menu and encoding their SKUs.Self mapping: The ally loads their menu from the partners portal and can enter the SKU of the menu item from there. This sku information is taken to obtain the association between the SKU and the rappi id of the item, to send it as part of the order information to the ally's POS.Automatic mapping: The ally must send their menu consuming the POST menu endpoint, where SKUs must be received for each item that is sent in the menu. The mapping is generated by sending the json from the menu, generating a new mapping version that is available in such a way that when generating an order, the system takes the information registered in the automatic mapping database, and sends the information translated from the order to the ally's POS.Improvements with automatic menuWe will reproduce the order of your products in the Rappi app as you send it from the POS.We will keep the promotion settings when you update the menus from the POS.Menu validation will be immediate, avoiding any delay in loading, and you will receive feedback instantly ("accepted", "rejected", or with "error").We will keep the history of customers favorites in the Rappi app, as we will keep your SKUs history.Creating a Menu for a StoreAPI ReferenceUse the POST menu endpoint to create menus through API.If you want a group of stores to share the same menu, you have to ask Rappi to configure one as a parent store and the rest as child stores. After this is done, you can only send menus for parent stores. If you send a menu for a child store the endpoint will reject it.To create a menu:Make a POST request to the following URL, and add a JSON object to the body of the request with the following objects.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/menu{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.This is an example of the JSON object in the body of the request:!!! note
If then need to change product availability, can use availability module!!! note
The values from this JSON are not real data. Ensure to replace them with your data when making API requests. You can add more items to the menu by adding more objects under items, separated by a comma.The system retrieves the confirmation message Menu updated and ready to be validated.!!! note
It's not possible to process more than 1 menu at a time, therefore, if there is already a menu in the approval process, all incoming menus from the same store will be ignoredYour menu is now under approval. You can consult the status of your menu by making a GET request to the menu endpoint. For more information, go to the Obtaining Menu Information section of this chapter.Validations on the Received menuWhen Rappi receives the menu, it makes several considerable validations.Empty Items List: If an empty items list is received, an error is displayed: Items is required.Items without sku: The SKU of the products and the toppings must not be empty or null. If this validation is not fulfilled, an error is displayed: This Store needs skus in all items.Valid names and description: For all items (products or toppings) it is validated that:The Product description must have at least 2 charactersThe item name must have at least 2 charactersThe item must contain a categoryThe Product ID category and the Toppings must not be empty or nullThe product category name and the Toppings must have at least 2 charactersThe maximum characters for the different fields are configurable parameters that may change over time.If it does not meet any of these validations, an error is displayed: All items must have a valid name, category or product description..In case you get an error due to this validation, please contact the Rappi official who is supporting your process.Valid item types: It's validated that the first level items are of the PRODUCT type and the items within the "children" list are of the TOPPING type. If this validation fails, an error is displayed: All parent items must be product type and children must be topping type.Duplicated toppings categories: Within a product, there cannot be two toppings categories with the same name and id but different sortingPosition. If this validation fails, an error is displayed The topping categories cannot be duplicated (same name and id but different sorting position)Duplicated product categories: There cannot be two products categories with the same name but different id or sortingPosition. If this validation fails, an error is displayed The product categories cannot be duplicated (same name but different id or sorting position)Toppings category limits: For all toppings, the following is validated:The maxQty of the topping category cannot be 0 or greater than 20The maxLimit of the topping cannot be 0 or greater than the maxQty of its categoryThe error displayed is: All toppings must have a valid maxQty or maxLimit must not be greater than maxQtyProduct with price Zero: For all products, the following is validated:Product without toppings (children) must have price greater than 0A product with toppings can have price of 0 if some of is children has a price greater than 0The error displayed is: Product price must be greater than 0 if the product doesn’t have any children. Otherwise at least one of its children must have price.Unique SKU: It will not be accepted for the same SKU to be sent twice with different names, descriptions, prices, or toppings. This rule only applies to products. It does not apply to topping categories, toppings, or subitems. The error message returned for this validation is: Menu contains products with same sku, but they have different attributes (including topping categories and toppings)|                                                                                                                                                                          Before                                                                                                                                                                           |                                                                                                                    Now                                                                                                                     |
| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| We accepted that two products with variations use the same SKU. For example: Name: Hamburger  Description: Hamburger  SKU: ABC123  Toppings:  - Extra  >> Tomato  Name: Burger  Description: Delicious Hamburger  SKU: ABC123  Toppings:  - Extra  >> Lettuce | We will only accept one SKU per product (otherwise they must be different SKUs). For example:  Name: Hamburger  Description: Hamburger  SKU: ABC123  Toppings:  - Extra  >> Tomato  >> Lettuce |!!! note
In the menu management process, Rappi only considers 2 levels of elements: Products and Toppings. Items are not allowed within a Topping.Image formats: The accepted formats for images are JPG, JPG200 and PNG. They must be a maximum of 1 MBUrl formats: All the images url should have a valid format and should start with http or https. If the validation fails, the following error is returned: Invalid urls were foundText with Emojis: In case that any text field has an Emoji, an error will be returned: Some text fields in the menu have emojis, please delete them..!!! note
Automatic menu does not support reusing skus (ids) when you create new topping categories, products, and toppings.Obtaining Menu InformationAPI ReferenceAfter Rappi approves the content of the menu, you can retrieve the contents of your store menus using the GET menu endpoint.To retrieve the contents of your store menus:Make a GET request to the following URL.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/menu{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.The system retrieves a JSON object response with the information of your store menus.Consulting the Approval Status of Your MenusAPI ReferenceAfter creating a menu using our API, the Rappi team validates the structure and the contents of your menu.You can use the GET menu/approved/{storeId} endpoint to consult the approval status of your menus.To consult the status of your menus:Make a GET request to the following URL.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/menu/approved/{storeId}{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.The system retrieves a JSON object response with the approval status of your store menus.!!! note
If the wait time for a menu approval exceeds the agreed SLA, the support team must be contacted to validate the status of the menu.Retrieving Your Last Created MenuAPI ReferenceUse the GET menu/rappi/{storeId} endpoint to retrieve the information of the last menu created for a specific store.To get the last created menu:Make a GET request to the following URL:URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/menu/rappi/{storeId}{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.{storeId}: This is the identifier of your store integration.The system retrieves a JSON response with the information of the last menu created for your store.


API Reference endpoint to retrieve the information of the last menu created for a specific store.GET menu/rappi/{storeId}Use the To get the last created menu: request to the following URL:GETMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/menu/rappi/{storeId}: URL: This is the identifier of your store integration.{storeId}.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} response with the information of the last menu created for your store.JSONThe system retrieves a


API ReferenceAfter creating a menu using our API, the Rappi team validates the structure and the contents of your menu. endpoint to consult the approval status of your menus.GET menu/approved/{storeId}You can use the To consult the status of your menus: request to the following URL.GETMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/menu/approved/{storeId}: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} object response with the approval status of your store menus.JSONThe system retrieves a !!! note
If the wait time for a menu approval exceeds the agreed SLA, the support team must be contacted to validate the status of the menu.


API Reference endpoint.GET menuAfter Rappi approves the content of the menu, you can retrieve the contents of your store menus using the To retrieve the contents of your store menus: request to the following URL.GETMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/menu: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} object response with the information of your store menus.JSONThe system retrieves a


When Rappi receives the menu, it makes several considerable validations.Menu contains products with same sku, but they have different attributes (including topping categories and toppings): It will not be accepted for the same SKU to be sent twice with different names, descriptions, prices, or toppings. This rule only applies to products. It does not apply to topping categories, toppings, or subitems. The error message returned for this validation is: Unique SKUProduct price must be greater than 0 if the product doesn’t have any children. Otherwise at least one of its children must have price.The error displayed is: A product with toppings can have price of 0 if some of is children has a price greater than 0Product without toppings (children) must have price greater than 0: For all products, the following is validated:Product with price ZeroAll toppings must have a valid maxQty or maxLimit must not be greater than maxQtyThe error displayed is: The maxLimit of the topping cannot be 0 or greater than the maxQty of its categoryThe maxQty of the topping category cannot be 0 or greater than 20: For all toppings, the following is validated:Toppings category limitsThe product categories cannot be duplicated (same name but different id or sorting position). If this validation fails, an error is displayed sortingPosition or id: There cannot be two products categories with the same name but different Duplicated product categoriesThe topping categories cannot be duplicated (same name and id but different sorting position). If this validation fails, an error is displayed sortingPosition: Within a product, there cannot be two toppings categories with the same name and id but different Duplicated toppings categoriesAll parent items must be product type and children must be topping type.: It's validated that the first level items are of the PRODUCT type and the items within the "children" list are of the TOPPING type. If this validation fails, an error is displayed: Valid item typesIn case you get an error due to this validation, please contact the Rappi official who is supporting your process..All items must have a valid name, category or product description.If it does not meet any of these validations, an error is displayed: The maximum characters for the different fields are configurable parameters that may change over time.The product category name and the Toppings must have at least 2 charactersThe Product ID category and the Toppings must not be empty or nullThe item must contain a categoryThe item name must have at least 2 charactersThe Product description must have at least 2 characters: For all items (products or toppings) it is validated that:Valid names and description.This Store needs skus in all items: The SKU of the products and the toppings must not be empty or null. If this validation is not fulfilled, an error is displayed: Items without sku.Items is required: If an empty items list is received, an error is displayed: Empty Items List >> Lettuce | >> Tomato  - Extra  Toppings:  ABC123 SKU:  Hamburger Description:  Hamburger Name:  >> Lettuce | We will only accept one SKU per product (otherwise they must be different SKUs). For example:  - Extra  Toppings:  ABC123 SKU:  Delicious Hamburger Description:  Burger Name:  >> Tomato  - Extra  Toppings:  ABC123 SKU:  Hamburger Description:  Hamburger Name:                                                                                                                      |
| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| We accepted that two products with variations use the same SKU. For example:Now                                                                                                                                                                           |                                                                                                                    Before|                                                                                                                                                                          !!! note
In the menu management process, Rappi only considers 2 levels of elements: Products and Toppings. Items are not allowed within a Topping..Some text fields in the menu have emojis, please delete them.: In case that any text field has an Emoji, an error will be returned: Text with EmojisInvalid urls were found: All the images url should have a valid format and should start with http or https. If the validation fails, the following error is returned: Url formats: The accepted formats for images are JPG, JPG200 and PNG. They must be a maximum of 1 MBImage formats!!! note
Automatic menu does not support reusing skus (ids) when you create new topping categories, products, and toppings.


API Reference endpoint to create menus through API.POST menuUse the  the endpoint will reject it.child store. If you send a menu for a parent stores. After this is done, you can only send menus for child stores and the rest as parent storeIf you want a group of stores to share the same menu, you have to ask Rappi to configure one as a To create a menu: object to the body of the request with the following objects.JSON request to the following URL, and add a POSTMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/menu: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} object in the body of the request:JSONThis is an example of the {
"storeId": "900103361",
"items": \[
{
"name": "Grilled Chicken Burger",
"description": "Grilled chicken burger description",
"price": 14000,
"sku": "10",
"sortingPosition": 0,
"type": "PRODUCT",
"category": {
"id": "2090019638",
"maxQty": 0,
"minQty": 0,
"name": "Burgers",
"sortingPosition": 0
},
"children": \[
{
"category": {
"id": "211",
"maxQty": 1,
"minQty": 0,
"name": "Do you want to add?",
"sortingPosition": 0
},
"name": "French Fries",
"description": "crunchy french fries",
"price": 5000,
"sku": "1",
"maxLimit": 1,
"sortingPosition": 1,
"type": "TOPPING"
},
{
"category": {
"id": "211",
"maxQty": 1,
"minQty": 0,
"name": "Do you want to add?",
"sortingPosition": 0
},
"name": "Potato Wedges",
"price": 7000,
"sku": "2",
"maxLimit": 1,
"sortingPosition": 1,
"type": "TOPPING"
}
]
},
{
"name": "Hawaiian Pizza",
"description": "hawaiian pizza description",
"price": 18000,
"sku": "11",
"sortingPosition": 1,
"type": "PRODUCT",
"category": {
"id": "2090019639",
"maxQty": 0,
"minQty": 0,
"name": "Pizzas",
"sortingPosition": 1
},
"children": \[]
}
]
}availability module!!! note
If then need to change product availability, can use , separated by a comma.items are not real data. Ensure to replace them with your data when making API requests. You can add more items to the menu by adding more objects under JSON!!! note
The values from this .Menu updated and ready to be validatedThe system retrieves the confirmation message !!! note
It's not possible to process more than 1 menu at a time, therefore, if there is already a menu in the approval process, all incoming menus from the same store will be ignored section of this chapter.Obtaining Menu Information endpoint. For more information, go to the menu request to the GETYour menu is now under approval. You can consult the status of your menu by making a


favorites in the Rappi app, as we will keep your SKUs history.We will keep the history of customers, avoiding any delay in loading, and you will receive feedback instantly ("accepted", "rejected", or with "error").Menu validation will be immediate when you update the menus from the POS.We will keep the promotion settings in the Rappi app as you send it from the POS.We will reproduce the order of your products


: The ally must send their menu consuming the POST menu endpoint, where SKUs must be received for each item that is sent in the menu. The mapping is generated by sending the json from the menu, generating a new mapping version that is available in such a way that when generating an order, the system takes the information registered in the automatic mapping database, and sends the information translated from the order to the ally's POS.Automatic mapping: The ally loads their menu from the partners portal and can enter the SKU of the menu item from there. This sku information is taken to obtain the association between the SKU and the rappi id of the item, to send it as part of the order information to the ally's POS.Self mapping: The ally loads their menu from the partners portal, without placing the SKUs of the menu items. Upon receiving an order, the json of the order will have the Rappi ids of the items but their SKUs will be null, so the ally is in charge of downloading their menu and encoding their SKUs.No mapping


API ReferenceThe Rappi API enables you to manage the menus of your stores.You can create and update menus in the platform, retrieve the items of the menus, and review the approval status of your requests to create or update menus.The main properties of the menus and the items created through the Rappi API consist of the following items:: Indicates if the element belongs to a combo. (if it is true it means that it belongs to a combo)combo: Maximum indicator of the item, it's required only if the type is toppingmaxLimit: The type of the itemtype: The position of the item in its categorysortingPosition: The SKU (Stock-Keeping Unit) the ally gives to this itemsku: The identifier Rappi gives to this itemrappiIds: The price of the item in the menuprice: The url of the image of the item in the menuimageUrl: The description of the item in the menudescription: The name of the item in the menuname: Subitems nested in a categorychildren: If it's a product category, it's the position of the category in the menu. In case of being a Topping category, it's the position of the category within the productsortingPosition: Category namename: The minimum quantity of elements that can be ordered in this category (In toppings, if it's 0 it means that it's not mandatory)minQty: The maximum number of items that can be ordered in this categorymaxQty: The SKU (Stock-Keeping Unit) the ally gives to this categoryid: The category of the items in the menucategory: The items in the menuitems: The store identifierstoreId
&#x20; Important
&#x20;When a menu is sent, full prices should be sent instead of prices with discounts applied 


API Reference endpoint.GET orders/{orderId}/eventsYou can retrieve the events of your order by using the To retrieve the events of your order: request to the following URL:GETMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/orders/{orderId}/events: URL: This is the identifier of your order.{orderId}.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} response with the record of the events of your order.JSONThe system retrieves a


API Reference endpoint to notify the Rappi application when an order is ready for pickup.POST orders/{orderId}/ready-for-pickupIf your stores have manual notification settings, use the To notify Rappi when an order is ready for pickup: request to the following URL:POSTMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/orders/{orderId}/ready-for-pickup: URL: This is the identifier of your order.{orderId}.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN}".Order successfully updated response with the confirmation message "JSONThe system retrieves a


API Reference status when:SENT endpoint to reject orders that are in PUT orders/{orderId}/rejectUse the The order contains items with an incorrect priceThe order contains invalid or unavailable items this endpoint to limit the number of orders the store processes. If you reject several orders for a given store within a short time, Rappi disables the store in the application.Do not use!!! important
to the body of the request.items\_id or the items\_skuYou can also disable items from the menu of the store when rejecting orders, by providing the  section of this portal.Manage Availability!!! note
The items you disable when rejecting an order can only be enabled again by Rappi Support. To see other ways to disable items, see the  to the body of the request with the following objects.JSON request to the following URL, and add a PUTTo reject an order make a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/orders/{orderId}/reject: URL: This is the identifier of the order.{orderId}.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} object in the body of the request:JSONThis is an example of the {
"reason": "The order has invalid items"
} in the JSON object."reason" objects under "items\_ids" or the "items\_sku"!!! note
To disable items from the menu of the store, add the ".Order successfully rejected object response with the confirmation message "JSONThe system retrieves a


This function allows you to set the cooking time of an order when you take it in the POS.What is cooking time?Orders have three possible cooking times, which will be applied in the following order.CT set up in the integration coreCMS CT (with maximums and minimums)Predictive CTHow does the CT work?The system goes through each CT in the order explained above to assign the order’s CT, and if it does not find one, it will continue with the next one until a CT is assigned.Is it possible to change the CT?Yes, you can change the CT with a value between the minimum and maximum set up in the integration core, and in case you choose a value out of the set up range, the system will select the minimum or maximum value set up in the integration core.


API Reference status.SENT endpoint to take orders that are in PUT orders/{orderId}/take/{cookingTime}Use the ; please use it along with exponential backoff to multiplicatively decrease the rate of the request.retry and the store starts its preparation. Although it is unusual, if you get a status different to 200, use resilience patterns as TAKEN!!! important
When you take an order, the system changes its status to  request to the following URL:PUTTo take an order make a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/orders/{orderId}/take/: URL: This is the identifier of your order.{orderId}.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN}./orders/{orderId}/take/{cookingTime}: {cookingTime}!!! note
You can modify the default cooking time of the order by entering a new cooking time at the end of the endpoint with the path parameter ".Order successfully taken object with the confirmation message "JSONThe system retrieves a


API Reference.SENT endpoint to retrieve a list of all the orders that are in GET orders/status/sentUse the  and that status has been updated within the time limit (10 minutes forward) will be retrieved.SENT!!! important
Only orders whose last status is Example: at 14:00 of 12/10/2021, and use this enpoint at 14:07, it returns the order, because 14:07 - 10 minutes = 13:57 and the status change hour was at 14:00 then is bigger than 13:57.SENTIf order change status to  at 14:00 of 12/10/2021, but use this enpoint at 17:30, it returns nothing, because 17:30 - 10 minutes = 17:20, and status change hour was at 14:00 then is lower than 17:20.SENTAnother example, if order change status to To retrieve new orders: request to the following URL:GETMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/orders/status/sent: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} parameter to your request.storeId!!! note
To retrieve only the orders of a specific store, add the  endpoint section of the API Reference.orders response structure in the JSON response with all the new orders of your stores. Consult the JSONThe system retrieves a  the orders.reject, or takeWhen you retrieve the list of your new orders, you can


API Reference status for further action.READY endpoint to retrieve a list of all the orders that are in GET ordersUse the .SENT to READY. After you retrieve these orders, the system changes their status from once!!! important
You can only retrieve new orders To retrieve new orders: request to the following URL:GETMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/orders: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} parameter to your request.storeId!!! note
To retrieve only the orders of a specific store, add the  endpoint section of the API Reference.orders response structure in the JSON response with all the new orders of your stores. Consult the JSONThe system retrieves a  the orders.reject, or takeWhen you retrieve the list of your new orders, you can


delivery method enabled, receive additional information in their API responses.marketplaceThe stores that have the The following table represents the additional information for each country.               | -               | -                | -               |main\_street\_quadrant | -               | -                | -               |
| -               | -                | complementary\_street\_prefix\_letter        | -               | -                | -               |
| -               | -                | complementary\_street\_number      | -               | -                | -               |
| -               | -                | complete\_complementary\_street                 | -               | -                | -               |
| -               | -                | main\_street\_prefix          | -               | -                | -               |
| -               | -                | main\_street\_prefix\_letter        | -               | -                | -               |
| -               | -                | complementary\_street\_letter         | -               | -                | -               |
| -               | -                | main\_street\_number\_or\_name                   | -               | -                | -               |
| -               | -                | main\_street\_type               | -               | -                | -               |
| -               | -                | complete\_main\_street        | -               | -                | -               |
| -               | -                | complementary\_street\_prefix                              | -               | -                | -               |
| -               | -                | meter      | -               | -                | -               |
| -               | -                | complementary\_street\_quadrant   | federal\_unit  | -               |
| -               | street\_number          | -               | main\_street\_number\_letter  | street\_number   | description    | -               |
| street\_name | street\_number        | complete\_main\_street\_number    | street\_name | street\_number   |
| description | street\_shorcut   | street\_name | complementary\_street\_without\_meter | street\_shorcut   | street\_name| Argentina       | Brazil           | Colombia                             | Mexico          | Peru             | Other Countries |
| --------------- | ---------------- | ------------------------------------ | --------------- | ---------------- | --------------- |
|


Depending on the delivery methods of your stores, the API responses contain specific information.The following table represents the common information shared between the different delivery methods. | The complete address of the order.            |complete\_address       | The address additional information.           |
| complement      | The postal code of the address of the order.  |
| postal\_code     | The neighborhood of the address of the order. |
| neighborhood             | The city of the address of the order.         |
| city| Field              | Description                                   |
| ------------------ | --------------------------------------------- |
|


Rappi enables you to configure different delivery methods for your orders.This table describes the available delivery methods:        | The customer picks up the order at the store. |pickup   | A courier from the store delivers the order.  |
| marketplace      | A Rappi courier delivers the order.           |
| delivery| Delivery Method | Description                                   |
| --------------- | --------------------------------------------- |
|  delivery methods.pickup and the marketplace option for all of your stores, and you can choose to enable the deliveryRappi always supports the You can configure these options at store level with your main Rappi point of contact.


. You can apply discounts to individual products, stores, or configure special discount campaigns for a limited number of users that place orders.The Partners Portal application or Rappi GrowthRappi enables you to configure discount campaigns by using the Use the Rappi API to see the discounts applied to orders, discount totals, and price totals.The following table describes the discounts information in the orders: | Discount value per product unit.                                                                 |discount\_product\_unit\_value      | Number of products to which the discount was applied.                                            |
| discount\_product\_units           | Value of the discount in currency assumed by the partner.                                        |
| amount\_by\_partner             | Discount value in currency assumed by Rappi.                                                     |
| amount\_by\_rappi      | The percentage of the discount assumed by the partner.                                           |
| percentage\_by\_partners         | The percentage of the discount assumed by Rappi.                                                 |
| percentage\_by\_rappi           | Indicates if the discount is subtracted from the product total with toppings or not.             |
| includes\_toppings                   | Maximum value in currency to be discounted.                                                      |
| max\_value                  | The discount value type can be either value or percentage.                                       |
| value\_type. |
| value\_type                   | The discount value can represent a percentage or a currency value depending on the raw\_value                        | Indicates the discount type.                                                                     |
| type                         | Product SKU if the discount applies to a product.                                                |
| sku                  | Product ID if the discount applies to a product.                                                 |
| product\_id                       | Discount name.                                                                                   |
| title                 | Descriptive message explaining the discount.                                                     |
| description                       | Discount value in currency.                                                                      |
| value| Discount Indicator            | Description                                                                                      |
| ----------------------------- | ------------------------------------------------------------------------------------------------ |
| The following table describes the indicators for the order totals available:       | The amount paid with Rappi Credits.                               |total\_rappi\_credits           | The amount paid with Rappi Pay.                                   |
| total\_rappi\_pay                       | The tip to pay to the courier.                                    |
| tip              | The additional totals of the order.                               |
| other\_totals               | The order service fee.                                            |
| service\_fee                  | The order shipping fee.                                           |
| shipping                   | The charges in the order.                                         |
| charges       | Discount applied to the customer by the Rappi support team.       |
| discount\_by\_support | The total amount in currency of discounts assumed by the partner. |
| total\_discount\_by\_partner              | The remaining amount to pay in cash by the customer.              |
| total\_to\_pay               | The order total with discounts.                                   |
| total\_order           | The total of the discounts.                                       |
| total\_discounts            | The total of the products without discounts.                      |
| total\_products| Total Indicator             | Description                                                       |
| --------------------------- | ----------------------------------------------------------------- |
|


When a cancelation occurs in the Rappi platform, the system generates a cancelation event depending on the scenario and the circumstances of the cancelation.The following table contains the existing cancelation events and their description:      | The courier service cancels the order, and Rappi applies a cancelation fee to the courier service. |cancel\_by\_sk\_with\_charge         | Rappi cancels an order that the user made to a closed store.                                       |
| canceled\_store\_closed  | Rappi cancels an order due to fraud detection.                                                     |
| canceled\_by\_fraud\_automation             | Rappi Customer Support cancels the order through the internal CMS tool.                            |
| canceled\_from\_cms    | The ally cancels an order using the Customer application.                                          |
| cancel\_by\_application\_user | Rappi Customer Support cancels the order, and Rappi applies a cancelation fee to the user.         |
| cancel\_by\_support\_with\_charge             | Rappi Customer Support cancels the order.                                                          |
| cancel\_by\_support        | The user cancels an order with no charges to the user.                                             |
| cancel\_without\_charges          | The user cancels an order, and Rappi applies a cancelation fee to the user.                        |
| canceled\_with\_charge                | The user cancels an order.                                                                         |
| cancel\_by\_user| Cancelation Event               | Occurs when:                                                                                       |
| ------------------------------- | -------------------------------------------------------------------------------------------------- |
|


During the lifecycle of an order, the system indicates a series of events, and each of these events triggers a different action in the Rappi application.For example, the system triggers an event when a courier is assigned to pick up an order at a store, and the event changes when the courier delivers this order to the customer.The Rappi API enables you to retrieve the events' history of the orders.The following table describes the events that can happen during the lifecycle of an order:                                           | N/A                                               |arrive          | Occurs when the customer receives the order..                                                                                                                                                                                                                      | close\_order                                     |
| close\_order                             | domiciliary\_in\_store               | Occurs when the order arrives at the customer home.                                                                                                                                                                                                                | arrive                                          |
| arrive                             | domiciliary\_in\_store  | Occurs when the store delivers the order to the courier.                                                                                                                                                                                                           | hand\_to\_domiciliary                             |
| hand\_to\_domiciliary                                | ready\_for\_pick\_up | Occurs when the courier is at the store.                                                                                                                                                                                                                           | domiciliary\_in\_store                            |
| domiciliary\_in\_store | replace\_storekeepertaken\_visible\_order    | Occurs when the store prepares the order and is ready for pickup.                                                                                                                                                                                                  | ready\_for\_pick\_up                               |
| ready\_for\_pick\_up                              | taken\_visible\_order  | Occurs when Rappi assigns a new courier the order. in this case, Rappi also provides the ETA that it will take for the courier to arrive at the store.                                                                                                             | replace\_storekeeper |
| replace\_storekeeper ready\_for\_pick\_up- The courier is assigned to the order, in this case, Rappi also provides the ETA that it will take for the courier to arrive at the store. | N/A                                                | - The order is assigned to the store inside Rappi, immediately after a successful take of an order.  | Occurs when:taken\_visible\_order| Order Event            | Event Description                                                                                                                                                                                                                                                  | Transitions From                                   | Transitions To                                    |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | ------------------------------------------------- |
|


When a user creates an order, the order follows a specific flow since the moment the application starts processing it. The system triggers some of these status changes automatically whenever the order updates in the Rappi application, and the others must be updated manually.The following table describes the different states that the order goes through:                                  | N/A                                                                             |TAKENManual | \*\*\*\* | When the store has prepared the order.                                            | AutomaticREADY\_FOR\_PICKUP | N/A                                                                             |
| \*\*WEBHOOKSENTREADY            | Automatic                     | \*\*\*          | When neither the store nor Rappi, takes any action on the order. TIMEOUT                | N/A                                                                             |
| \*\*WEBHOOKSENT         | When the store rejects the order.                                                 | Manual                        | REJECTED                                                              |
| READY\_FOR\_PICKUP                | \*\*WEBHOOKSENT            | When the store accepts the order.                                                 | Manual                        | TAKEN                                     |
| TIMEOUTREJECTED TAKEN                 | WEBHOOKREADYAutomatic->   |              | When the application confirms the receipt of the order by the store.              | Manual->SENT                                                         |
| TIMEOUTSENT               | WEBHOOKCREATED            | When the application processes the order and is ready to be shipped to the store. | Automatic                     | READY |
| \*\*TIMEOUT\*\*REJECTED\*\*TAKEN\*SENT\*READY                                | CREATED          | When the order is being processed via webhook.                                    | Automatic                     | WEBHOOK                                                        |
| READYWEBHOOK          | When a user creates an order in the Rappi application.                            | Automatic                     | N/A                                      | CREATED| Order Status       | Description                                                                       | Update Type                   | Transitions From                         | Transitions To                                                                  |
| ------------------ | --------------------------------------------------------------------------------- | ----------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------- |
|  .WEBHOOKIf the order is being processed via webhook, its initial status will be  status is carried out automatically.SENTin case the order is being processed through webhook, it is not necessary to make the query unless that an error occurs in the process, since the order is sent to the store and the transition to the \* endpoint, GET orders?storeId={storeId} status can be queried at the READYOrders in  , but it is possible to take or reject the order.WEBHOOKThere are cases in which the ally has a webhook, but for some reason the response of the webhook is not successful, said order is considered as an order not received by the ally, Rappi keeps the order status in \*\* status; TIMEOUT , there is a time limit of 6 minutes to take or reject the order, otherwise it will transition to (ORDERS) status, they can be taken or rejected manually SENTWhen the orders are in the  status.TIMEOUTOrders can be in the integration process for a maximum of 6 minutes, otherwise the order will transition to the \*\*\* automatically.READY\_FOR\_PICKUP to the TAKENBy default, the system transitions the order from  manually, considering the following:READY\_FOR\_PICKUPYou can request Rappi to manage the transition to \*\*\*\* endpoint when the order is ready.POST orders/{orderId}/ready-for-pickup, you are required to call the ManualWhen set to , Rappi transitions the status of the order based on the cooking time of the store and order delay records.AutomaticWhen set to , to avoid any impact in the flow of your orders.Automatic!!! important
Rappi recommends keeping this transition set to !!! important
If you try to transition an order to an illegal state (for instance, reject an order already taken) it will end in an impossibility of iterate the order and returning an invalid transition messageThe following image describes the different states that the order goes through:


The following sections describe the properties of the orders, their different status, and the events that occur in the orders.


API ReferenceThe Rappi API enables you to manage the orders that the users make using the Rappi application. The following sections describe the process to:Get user orders through API requestsManage the workflow and status of the user orders


Managing AvailabilityAPI ReferenceThe Rappi API enables you to configure the availability of your menu items and your stores, by using the items resource.The following sections guide you through the process of configuring these options for your integration.Item AvailabilityConfigure the availability of your menu items and disable them when they are out of stock, to prevent incoming orders that contain unavailable products.The Rappi API enables you to configure availability by:Item SKU: This is the SKU you provided for the item to the Rappi when uploading to the menu.Item ID: This is the identifier that Rappi provided you when uploading to the menu.Consulting the Availability by SKUAPI ReferenceUse the POST availability/items/status endpoint to query the availability of your items by item SKU.To check the availability of your items by Item SKU:Make a POST request to the following URL, and add a JSON to the body of the request with the following objects.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/items/status{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.This is an example of the JSON in the body of the request:!!! note
The values from this JSON are not real data. Ensure to replace them with your data when making API requests.This is an example JSON of the response:Consulting the Availability by Rappi IDAPI ReferenceUse the POST availability/items/rappi/status endpoint to query the availability of your items by item SKU.To check the availability of your items by Item SKU:Make a POST request to the following URL, and add a JSON to the body of the request with the following objects.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/items/rappi/status{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.This is an example of the JSON in the body of the request:!!! note
The values in this JSON are not actual data. Be sure to replace them with your data when making API requests.This is an example JSON of the response:Setting Availability by SKUAPI ReferenceUse the PUT availability/stores/items endpoint to configure the availability of your items by Item SKU.To configure the availability of your items by Item SKU:Make a PUT request to the following URL, and add a JSON to the body of the request with the following objects.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/token{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.This is an example of the JSON in the body of the request:!!! note
The values from this JSON object are not real data. Ensure to replace them with your own data when making API requests. You can add more items to the turn\_on and turn\_off JSON objects separated by a comma. If you only want to turn on or turn off items in your request, remove the other object from your JSON accordingly.The system retrieves a JSON response with the confirmation message Items successfully updated.Setting Availability by Rappi IDAPI ReferenceUse the PUT availability/stores/items/rappi endpoint to configure the availability of your items by Item ID.To configure the availability of your items by Item ID:Make a PUT request to the following URL, and add a JSON to the body of the request with the following objects.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores/items/rappi{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.This is an example of the JSON in the body of the request:!!! note
The values from this JSON are not real data. Ensure to replace them with your data when making API requests. You can add more items to the turn\_on and turn\_off JSON objects separated by a comma. If you only want to turn on or turn off items in your request, remove the other object from your JSON accordingly.The system returns a JSON response with the confirmation status message "Items successfully updated".Store statusAPI ReferenceUse the POST availability/stores endpoint to check the availability of your stores.To check the availability of your stores:Make a POST request to the following URL and add a JSON to the request body with the following structure.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.This is an example of the JSON in the body of the request:This is an example of the JSON response:Health CheckThis is a procedure that run every minute to check the status of each store associated to a webhook. When a store is not available it will be turned off until it is available again!!! Important
This procedure will only be available for those stores that are using the NEW\_ORDER webhook and are subscribed to PINGBehaviourA POST will be sent to the url configurated in the webhook with the following format:Where store\_id represents the id of the store configurated on your side (external id)The response should have the following format:status: this field is required, if the value is null or different to OK it will be considered as unavailable store.description: this field is optional.HOW DOES PING WORK?OBJECTIVE Detect when a store loses connectivity and turn it off when a ping change from positive to negative occurs, in order to prevent future cancellations due to said lack of connectivity in the store to accept the take. This Ping must be implemented for each store and not on a central server.FUNCTION The monitor receives a notification every time a store goes from being pinged positive to negative. Realizing this, he immediately sends himself to turn off the shop in question.When a webhook is configured, the ping is sent every 3 minutes, in case of not having a webhook and using Order Pulling, it will be evaluated every 3 minutes.Depending on the number of negative pings configured, a Negative Ping incident is generated.The time range configured for grace time will be 1 minute.The maximum number of attempts allowed for non-response for a shop is currently set to 2 for all allies.Only after validating the intermittence time, the connectivity loss or recovery incident is generated according to its definition.PING RULESThese are the following rules that we take into accountPING NEGATIVE This rule creates a Lost Connectivity incident, this incident is Status: Open awaiting a Positive Ping.PING POSITIVE In this rule, an alert is triggered that looks for the Lost Connectivity incident Status: Open to change it to Status: Closed.Store Availability (asynchronous)API ReferenceUse the PUT availability/stores endpoint to configure the availability of your stores.To configure the availability of your stores:Make a PUT request to the following URL, and add a JSON to the body of the request with the following objects.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.This is an example of the JSON in the body of the request:The system retrieves a JSON response with the confirmation message "Stores successfully updated".Store Availability massive (asynchronous)API ReferenceUse the PUT availability/stores/enable/massive endpoint to configure the availability of your stores.To configure the availability of your stores:Make a PUT request to the following URL, and add a JSON to the body of the request with the following objects.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores/enable/massive{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.This is an example of the JSON in the body of the request:Store Availability (synchronous)API ReferenceUse the PUT availability/stores/enable endpoint to configure the availability of your stores.To configure the availability of your stores:Make a PUT request to the following URL, and add a JSON to the body of the request with the following objects.URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores/enable{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.This is an example of the JSON in the body of the request:This is an example of the response:


API Reference endpoint to configure the availability of your stores.PUT availability/stores/enableUse the&#x20;
&#x20;Important
&#x20;This is a synchronous method so the operation's result will come in the response.&#x20;
&#x20;Keep in mind that the max amount of stores is 300. If you need to send more stores use the async method.
See  Store Availability (asynchronous)
&#x20;It is possible that a store cannot be turn on/off because it is suspended or not published in the Rappi app


API Reference endpoint to configure the availability of your stores.PUT availability/stores/enable/massiveUse the&#x20;
&#x20;Important
&#x20;This is an asynchronous method so the operation's result will not come in the response. Using this approach you can receive the updated store status through the STORE\_CONNECTIVITY webhook.
See Store Connectivity&#x20;
&#x20;It is possible that a store cannot be turn on/off because it is suspended or not published in the Rappi app


API Reference endpoint to configure the availability of your stores.PUT availability/storesUse the&#x20;
&#x20;Important
&#x20;This is an asynchronous method so the operation's result will not come in the response. Using this approach you can receive the updated store status through the STORE\_CONNECTIVITY webhook.
See Store Connectivity&#x20;
&#x20;If an instant response is needed the synchronous endpoint should be use.
See  Store Availability (synchronous)


These are the following rules that we take into account awaiting a Positive Ping.Status: Open This rule creates a Lost Connectivity incident, this incident is PING NEGATIVE.Status: Closed to change it to Status: Open In this rule, an alert is triggered that looks for the Lost Connectivity incident PING POSITIVE


Detect when a store loses connectivity and turn it off when a ping change from positive to negative occurs, in order to prevent future cancellations due to said lack of connectivity in the store to accept the take. This Ping must be implemented for each store and not on a central server.OBJECTIVE The monitor receives a notification every time a store goes from being pinged positive to negative. Realizing this, he immediately sends himself to turn off the shop in question.FUNCTIONOnly after validating the intermittence time, the connectivity loss or recovery incident is generated according to its definition.The maximum number of attempts allowed for non-response for a shop is currently set to 2 for all allies.The time range configured for grace time will be 1 minute.Depending on the number of negative pings configured, a Negative Ping incident is generated.When a webhook is configured, the ping is sent every 3 minutes, in case of not having a webhook and using Order Pulling, it will be evaluated every 3 minutes.
&#x20; Important
If you do not use webhooks, the evaluation every 3 minutes is done on the last time you downloaded orders, the grace time to determine if it is a negative ping is 1 minute 


will be sent to the url configurated in the webhook with the following format:POSTA {
"store\_id": 999
} represents the id of the store configurated on your side (external id)store\_idWhere The response should have the following format:{
"status": "OK",
"description": "Tienda prendida"
}: this field is optional.description: this field is required, if the value is null or different to OK it will be considered as unavailable store.status


This is a procedure that run every minute to check the status of each store associated to a webhook. When a store is not available it will be turned off until it is available again!!! Important
This procedure will only be available for those stores that are using the NEW\_ORDER webhook and are subscribed to PING


API Reference endpoint to check the availability of your stores.POST availability/storesUse the To check the availability of your stores: to the request body with the following structure.JSON request to the following URL and add a POSTMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} in the body of the request:JSONThis is an example of the \[900105433]
Note

The values in this JSON are not actual data. Be sure to replace them with your data when making API requests.
You can add more stores in the JSON separated by a comma.
You can query up to 100 stores in your JSON.


API Reference endpoint to configure the availability of your items by Item ID.PUT availability/stores/items/rappiUse the To configure the availability of your items by Item ID: to the body of the request with the following objects.JSON request to the following URL, and add a PUTMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores/items/rappi: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} in the body of the request:JSONThis is an example of the \[
{
"store\_integration\_id": "999",
"items": {
"turn\_on": \[1111, 2222, 3333],
"turn\_off": \[5555]
}
}
] accordingly.JSON items in your request, remove the other object from your turn off or turn on objects separated by a comma. If you only want to JSON turn\_off and turn\_on are not real data. Ensure to replace them with your data when making API requests. You can add more items to the JSON!!! note
The values from this ".Items successfully updated response with the confirmation status message "JSONThe system returns a


API Reference endpoint to configure the availability of your items by Item SKU.PUT availability/stores/itemsUse the To configure the availability of your items by Item SKU: to the body of the request with the following objects.JSON request to the following URL, and add a PUTMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/token: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} in the body of the request:JSONThis is an example of the \[
{
"store\_integration\_id": "999",
"items": {
"turn\_on": \["1111", "2222", "3333"],
"turn\_off": \["5555"]
}
}
] accordingly.JSON items in your request, remove the other object from your turn off or turn on objects separated by a comma. If you only want to JSON turn\_off and turn\_on object are not real data. Ensure to replace them with your own data when making API requests. You can add more items to the JSON!!! note
The values from this .Items successfully updated response with the confirmation message JSONThe system retrieves a


API Reference endpoint to query the availability of your items by item SKU.POST availability/items/rappi/statusUse the To check the availability of your items by Item SKU: to the body of the request with the following objects.JSON request to the following URL, and add a POSTMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/items/rappi/status: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} in the body of the request:JSONThis is an example of the {
"store\_id": "900144512",
"item\_ids": \["2136411304"]
} are not actual data. Be sure to replace them with your data when making API requests.JSON!!! note
The values in this  of the response:JSONThis is an example \[
{
"item\_id": 2136411304,
"item\_type": "PRODUCT",
"stock\_out\_state": "AVAILABLE"
}
]


API Reference endpoint to query the availability of your items by item SKU.POST availability/items/statusUse the To check the availability of your items by Item SKU: to the body of the request with the following objects.JSON request to the following URL, and add a POSTMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/items/status: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} in the body of the request:JSONThis is an example of the {
"store\_id": "900144512",
"item\_ids": \["7713", "2668", "3395", "5685"]
} are not real data. Ensure to replace them with your data when making API requests.JSON!!! note
The values from this  of the response:JSONThis is an example \[
{
"item\_id": 2136411305,
"item\_type": "PRODUCT",
"stock\_out\_state": "AVAILABLE"
},
{
"item\_id": 2136411307,
"item\_type": "PRODUCT",
"stock\_out\_state": "AVAILABLE"
},
{
"item\_id": 2136411304,
"item\_type": "PRODUCT",
"stock\_out\_state": "AVAILABLE"
},
{
"item\_id": 2136411306,
"item\_type": "PRODUCT",
"stock\_out\_state": "AVAILABLE"
}
]


Configure the availability of your menu items and disable them when they are out of stock, to prevent incoming orders that contain unavailable products.The Rappi API enables you to configure availability by:: This is the identifier that Rappi provided you when uploading to the menu.Item ID: This is the SKU you provided for the item to the Rappi when uploading to the menu.Item SKU


API Reference resource.itemsThe Rappi API enables you to configure the availability of your menu items and your stores, by using the The following sections guide you through the process of configuring these options for your integration.


Retrieving Stores Data

API Reference

Use the GET stores-pa endpoint to retrieve the following information from your stores.

integrationId It is the id of the store that you assign in the integration.

rappiId It is the id of the store assigned by Rappi.

name It is the name of the store.

!!! important
The stores to show are those that are only associated with your clientId.

To retrieve this information:

Make a GET request to the following URL.

URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/stores-pa

{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

The system returns a JSON response with the information of your stores.

Menú info

API Reference

Use the GET store/{RAPPI\_ID}/menu/current endpoint to retrieve the menu information from your store.

Products

id This is Rappi id from the product.

name Product name.

price Product price.

toppings Toppings from the product.

Toppings

id This is Rappi id from the topping.

name This is name from the Topping.

price This is price from the Topping.

category This is category information from the Topping.

Topping Category

id This is Rappi id from the topping category.

name Topping category name.

!!! important
The stores to show are those that are only associated with your clientId.

To retrieve this information:

Make a GET request to the following URL.

URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/store/{RAPPI\_ID}/menu/current

{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

{RAPPI\_ID}: This is Rappi id from the store.

The system returns a JSON response with the information of your menu from the store.

Check-In Code

API Reference

Use the GET /stores-pa/{storeId}/check-in-code endpoint to obtain the following information from the check-in code assigned to your store.

store\_id It is the id of the consulted store.

code It is the store check-in code assigned by Rappi.

created\_at It is the creation date of the check-in code assigned for the store.

updated\_at It is the update date of the check-in code assigned to the store.

expired\_at It is the expiration date of the check-in code assigned to the store.

!!! important
The check-in code information to display is for those stores that are associated only with your clientId.

To retrieve this information:

Make a GET request to the following URL.

URL: https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/stores-pa/{storeId}/check-in-code

{COUNTRY\_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

The system returns a JSON response with the check-in code information for the store.


API Reference endpoint to obtain the following information from the check-in code assigned to your store.GET /stores-pa/{storeId}/check-in-codeUse the It is the expiration date of the check-in code assigned to the store. expired\_atIt is the update date of the check-in code assigned to the store. updated\_atIt is the creation date of the check-in code assigned for the store. created\_atIt is the store check-in code assigned by Rappi. codeIt is the id of the consulted store. store\_id.clientId!!! important
The check-in code information to display is for those stores that are associated only with your To retrieve this information: request to the following URL.GETMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/stores-pa/{storeId}/check-in-code: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} response with the check-in code information for the store.JSONThe system returns a


Topping category name. nameThis is Rappi id from the topping category. id.clientId!!! important
The stores to show are those that are only associated with your To retrieve this information: request to the following URL.GETMake a https://{COUNTRY\_DOMAIN}/api/v2/restaurants-integrations-public-api/store/{RAPPI\_ID}/menu/current: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN}: This is Rappi id from the store.{RAPPI\_ID} response with the information of your menu from the store.JSONThe system returns a


Country	Domain URL
Argentina	`https://api.rappi.com.ar`
Brazil	`https://api.rappi.com.br`
Chile	`https://api.rappi.cl`
Colombia	`https://api.rappi.com.co`
Costa Rica	`https://api.rappi.co.cr`
Ecuador	`https://api.rappi.com.ec`
Mexico	`https://api.rappi.com.mx`
Peru	`https://api.rappi.pe`
Uruguay	`https://api.rappi.com.uy`