
# Deprecations

## Deprecations headers

Everytime changes or deprecations are made to the API, two headers indicating it will be sent through the HTTP responses and requests in weboohoks

- `x-rappi-api-deprecation-date`: HTTP Header indicating the date on which the change will be made.

- `x-rappi-api-deprecation-info`: HTTP Header indicating the URL where more information regarding the change will be found.

## Total and discounts changes

As of November 1, 2022, the way in which totals and discounts are displayed on the order will be changed.
<br/>
<br/>
The fields related to discounts on items and subitems will be removed, additionally the price of items and subitems will be reflected without discount in a new `price` field.

<pre>
<code>
{
  "order_id",
  ...,
  "items": [
    {
      "id",
      "sku",
      "name",
      "type",
      "comments",
      "price",
      "unit_price_with_discount", // Deprecated
      "unit_price_without_discount", // Deprecated
      "percentage_discount", // Deprecated
      "quantity",
      "subitems": [
        {
          "id",
          "sku",
          "name",
          "type",
          "comments",
          "price",
          "unit_price_with_discount", // Deprecated
          "unit_price_without_discount", // Deprecated
          "percentage_discount", // Deprecated
          "quantity",
          "subitems"
        }
      ]
    }
  ]
}
</code>
</pre>

The information associated with discounts will be found in the order, in a `discounts` field that has a list of all associated discounts.

<pre>
<code>
{
  "order_id",
  ...,
  "discounts": [
    {
      "value",
      "description",
      "title",
      "product_id",
      "sku",
      "type",
      "raw_value",
      "value_type",
      "max_value",
      "includes_toppings",
      "percentage_by_rappi",
      "percentage_by_partners",
      "amount_by_rappi",
      "amount_by_partner",
      "discount_product_units",
      "discount_product_unit_value"
    }
  ]
}
</code>
</pre>

The discounts fields will be removed will be removed from totals in favor of a single `total_discounts` field and a `discount_by_support` field will be added.

<pre>
<code>
{
  "order_id",
  ...,
  "totals": {
    "total_products",
    "total_discounts",
    "total_products_with_discount", // Deprecated
    "total_products_without_discount", // Deprecated
    "total_other_discounts", // Deprecated
    "total_order",
    "total_to_pay",
    "discount_by_support",
    "charges": {
      "shipping",
      "service_fee"
    },
    "other_totals": {
      "tip",
      "total_rappi_pay",
      "total_rappi_credits"
    }
  }
}
</code>
</pre>

You can find more information about the total fields and discounts [here](/en/managing-user-orders#order-totals-and-discounts)


Deprecations

What is an Integration?

Benefits of the Integration

Process Improvements

Portal Overview

Country Domains

Getting Started

Authentication Requirements

Generating an Access Token

Using Your Access Token

Authentication Process

Types of mapping

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

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

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 Process

API Reference

This 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 Requirements

Rappi 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 it

Generating an Access Token

API Reference

Generate 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.

Development URL:
https://rests-integrations-dev.auth0.com/oauth/token

Production URL:
https://rests-integrations.auth0.com/oauth/token

The following code sample the structure of the JSON object in the body of the request:



!!! 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  | Vlue                                                          |
| ------------- | ------------------------------------------------------------- |
| Public Api V2 | {Country domain}/api/v2/restaurants-integrations-public-api |
| Utils         | https://rest-ops-utils/api                                  |

Using Your Access Token

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:

| 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         | {Country domain}/api/v2/restaurants-integrations-public-api| API Audience  | Vlue                                                          |
| ------------- | ------------------------------------------------------------- |
| Public Api V2 |


Audiences

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://rests-integrations.auth0.com/oauth/token:
Production URLhttps://rests-integrations-dev.auth0.com/oauth/token:
Development URL object in the body of the request:JSONThe following code sample the structure of the {
"client\_id": "7iCfjZCO4bTns3OjqLK4de2GV3sp6Ymd",
"client\_secret": "40iFFYJV9A1LrVmJsaIeARW40iFFYJV9A1LrVmJsaIeARW40iFFYJV9A1LrVmJsaIeARW",
"audience": "https://int-public-api-v2/api",
"grant\_type": "client\_credentials"
} 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 Menus

API Reference

The 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 identifier

items: The items in the menu

category: The category of the items in the menu

id: The SKU (Stock-Keeping Unit) the ally gives to this category

maxQty: The maximum number of items that can be ordered in this category

minQty: 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 name

sortingPosition: 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 product

children: Subitems nested in a category

name: The name of the item in the menu

description: The description of the item in the menu

imageUrl: The image url of the item in the menu

price: The price of the item in the menu

rappiIds: The identifier Rappi gives to this item

sku: The SKU (Stock-Keeping Unit) the ally gives to this item

sortingPosition: The position of the item in its category

type: The type of the item

maxLimit: Maximum indicator of the item, it's required only if the type is topping

combo: 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 mapping

No mapping: The ally loads his 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 his 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 his 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'POS.

Creating a Menu for a Store

API Reference

Use 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 ignored

Your 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 menu

When 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 characters

The item name must have at least 2 characters

The item must contain a category

The Product ID category and the Toppings must not be empty or null

The product category name and the Toppings must have at least 2 characters

The 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 20

The maxLimit of the topping cannot be 0 or greater than the maxQty of its category

The error displayed is: All toppings must have a valid maxQty or maxLimit must not be greater than maxQty

Product with price Zero: For all products, the following is validated:

Product without toppings (children) must have price greater than 0

Product with toppings, can have price 0 if some of his children has price greater than 0

The 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.

!!! 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 MB

Url 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 found

Text 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 Information

API Reference

After 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 Menus

API Reference

After 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
Please refer to rappi support team in case of your menu took more than the defined SLA

Retrieving Your Last Created Menu

API Reference

Use 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
Please refer to rappi support team in case of your menu took more than the defined SLA


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.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.The error displayed is: Product with toppings, can have price 0 if some of his children has 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!!! 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


: The ally must send his 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'POS.Automatic mapping: The ally loads his 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 his 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 image url 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 send , full prices should be sent instead of discounted prices applied.&#x20;



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}".Order successfully taken object with the confirmation message "JSON.
The system retrieves a /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


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 Availability

API Reference

The 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 Availability

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:

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 SKU

API Reference

Use 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 object are not real data. Ensure to replace them with your own data when making API requests.

This is an example JSON of the response:



Consulting the Availability by Rappi ID

API Reference

Use 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 from this JSON object are not real data. Ensure to replace them with your own data when making API requests.

This is an example JSON of the response:



Setting Availability by SKU

API Reference

Use 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 ID

API Reference

Use 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 status

API Reference

Use 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 Check

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

Behaviour

A 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 RULES

These are the following rules that we take into account

PING 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 Reference

Use 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 Reference

Use 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 Reference

Use 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&#x20;



API Reference endpoint to configure the availability of your stores.PUT availability/stores/enable/massiveUse the&#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&#x20;



API Reference endpoint to configure the availability of your stores.PUT availability/storesUse the&#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)&#x20;



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; Importante
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"]
} object are not real data. Ensure to replace them with your own data when making API requests.JSON!!! note
The values from 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"]
} object are not real data. Ensure to replace them with your own 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


This is category information from the Topping. categoryThis is price from the Topping. priceThis is name from the Topping. nameThis is Rappi id from the topping. id


Toppings from the product. toppingsProduct price. priceProduct name. nameThis is Rappi id from the product. id


API Reference endpoint to retrieve the menu information from your store.GET store/{RAPPI\_ID}/menu/currentUse the


API Reference endpoint to retrieve the following information from your stores.GET stores-paUse the It is the name of the store. nameIt is the id of the store assigned by Rappi. rappiIdIt is the id of the store that you assign in the integration. integrationId.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/stores-pa: URL.See the list of Country Domains: This is your Rappi Country Domain. {COUNTRY\_DOMAIN} response with the information of your stores.JSONThe system returns a


Webhook Events

API Reference

You can set webhooks through API that enable you to receive notifications about events that happen in your stores.

These are the events available to retrieve with webhooks:

NEW\_ORDER: New orders

ORDER\_EVENT\_CANCEL: Order cancellation events. See Cancellation Events

ORDER\_OTHER\_EVENT: Order events. See Order Events

MENU\_APPROVED: Menu approval events.

MENU\_REJECTED: Menu rejection events.

PING: This event enables the health check procedure

STORE\_CONNECTIVITY: This event enables the store connectivity information process. (When the store is available or unavailable to operate)

Use the endpoints of the Webhooks resource to register and test webhooks in your stores.



Webhook event payloads



NEW\_ORDER



The NEW\_ORDER event is going to send the same information that we can get from the getOrders endpoint for the order that fires the event. We can find more information about the body at the API reference

ORDER\_EVENT\_CANCEL



The ORDER\_EVENT\_CANCEL event will send the payload with the following format:



Where event represents the name of the cancelled event.

Where order\_id represents the id of the order.

Where store\_id represents the id of the store in the rappi app.

ORDER\_OTHER\_EVENT



The ORDER\_OTHER\_EVENT event will send the payload with the following format:



Where event represents the name of the event.

Where order\_id represents the id of the order.

Where store\_id represents the id of the store in the rappi app.

Where event\_time represents the day and time of the event.

Where additional\_information represents detailed information about the order.

MENU\_APPROVED



The MENU\_APPROVED event will send the payload with the following format:



Where store\_id represents the id of the store in the rappi app.

Where message is the menu approval message.

MENU\_REJECTED



The MENU\_REJECTED event will send the payload with the following format:



Where store\_id represents the id of the store in the rappi app.

PING



The PING event will send the payload with the following format:



Where store\_id represents the id of the store in the rappi app.

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 suspend the shop in question. As an administrator you can configure the number of strikes to apply the negative ping rules.

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 current number of strikes is 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 RULES

These are the following rules that we take into account

PING 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\_CONNECTIVITY



The STORE\_CONNECTIVITY event will send the payload with the following format:



Where external\_store\_id (String) represents the id of the store configurated on your side.

Where enabled (boolean) represents with a binary value of the store is available to operate or not.

Where message (String) represents a message informing if the store is available or not.

Security

Our Public API has signatures for the security of its webhooks using a hash-based message authentication code (HMAC) with SHA-256 (Secure Hash Algorithm 2).
Each request has its own signature which will come in the header with the name of Rappi-Signature and will have the following format



Validating Your Signature

You can validate the signature that come in the header following the steps below

!!! Important
To validate the signature, you will need the secret of your webhook.

Extract the timestamp and signatures from the header.

1.1 Separate with a comma "," to create a list.

1.2 Separate each element again with "=" to obtain t and a sign.

t: Is the timestamp from the request

sign: Is the signature

Create the signed\_payload string by concatenating:

The timestamp

The character .

The actual payload

Example:



Compute an HMAC with the SHA256 hash function. Use the secret as the key, and use the signed\_payload string as the message to determine the expected signature.

Compare the signature in the header with the expected signature.

You can now ensure that the information is valid.

!!! Note
Make sure you are taking the payload string in the same format that it arrives in order to avoid any differences in the signature


You can validate the signature that come in the header following the steps below of your webhook.secret!!! Important
To validate the signature, you will need the Compare the signature in the header with the expected signature. string as the message to determine the expected signature.signed\_payloadCompute an HMAC with the SHA256 hash function. Use the secret as the key, and use the 123456.{ "message" : "this is an example" }Example:The actual payload.The character The timestamp string by concatenating:signed\_payloadCreate the : Is the signaturesign: Is the timestamp from the requestt.sign and a t1.2 Separate each element again with "=" to obtain 1.1 Separate with a comma "," to create a list.Extract the timestamp and signatures from the header.You can now ensure that the information is valid.!!! Note
Make sure you are taking the payload string in the same format that it arrives in order to avoid any differences in the signature


and will have the following formatRappi-SignatureOur Public API has signatures for the security of its webhooks using a hash-based message authentication code (HMAC) with SHA-256 (Secure Hash Algorithm 2).
Each request has its own signature which will come in the header with the name of t=123456,sign=d74b65c2e68c1a84a4d5843a69ef5faf1d82f28df2dd3723e8e0dad9c54abc79
&#x20; Important
Headers described in this portal are NOT case-sensitive. To get more information check this Link



&#x20;event will send the payload with the following format:STORE\_CONNECTIVITYThe {
"external\_store\_id": "999",
"enabled": false,
"message": "The Store is not enabled to operate"
} represents the id of the store configurated on your side.external\_store\_id (String)Where  represents with a binary value of the store is available to operate or not.enabled (boolean)Where  represents a message informing if the store is available or not.message (String)Where


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 suspend the shop in question. As an administrator you can configure the number of strikes to apply the negative ping rules.FUNCTIONOnly after validating the intermittence time, the connectivity loss or recovery incident is generated according to its definition.The current number of strikes is 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; Importante
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



&#x20;event will send the payload with the following format:PINGThe {
"store\_id": 999
} represents the id of the store in the rappi app.store\_idWhere The response should have the following format:{
"status": "OK",
"description": "Store on"
}: this field is required, if the value is null or different to OK it will be considered as unavailable store.status: this field is optional.description


&#x20;event will send the payload with the following format:MENU\_REJECTEDThe {
"store\_id": "900109448"
} represents the id of the store in the rappi app.store\_idWhere


&#x20;event will send the payload with the following format:MENU\_APPROVEDThe {
"store\_id": "900109448",
"message": "Menu Approved"
} represents the id of the store in the rappi app.store\_idWhere  is the menu approval message.messageWhere


&#x20;event will send the payload with the following format:ORDER\_OTHER\_EVENTThe {
"event": "taken\_visible\_order",
"order\_id": "344949817",
"store\_id": "10000682",
"event\_time": "2023-05-04 12:01:22",
"additional\_information": {
"courier\_data": {
"id": 729365,
"phone": "3118012176",
"full\_name": "Daletzi Karina Olmedo Plata",
"last\_name": "Olmedo Plata",
"first\_name": "Daletzi Karina",
"profile\_pic": null
},
"eta\_to\_store": 147,
"storekeeper\_name": "Daletzi Karina Olmedo Plata"
}
} represents the name of the event.eventWhere  represents the id of the order.order\_idWhere  represents the id of the store in the rappi app.store\_idWhere  represents the day and time of the event.event\_timeWhere  represents detailed information about the order.additional\_informationWhere


&#x20;event will send the payload with the following format:ORDER\_EVENT\_CANCELThe {
"event": "canceled\_with\_charge",
"order\_id": "106",
"store\_id": "900109448"
} represents the name of the cancelled event.eventWhere  represents the id of the order.order\_idWhere  represents the id of the store in the rappi app.store\_idWhere


API reference event is going to send the same information that we can get from the getOrders endpoint for the order that fires the event. We can find more information about the body at the NEW\_ORDERThe


API ReferenceYou can set webhooks through API that enable you to receive notifications about events that happen in your stores.These are the events available to retrieve with webhooks:: This event enables the store connectivity information process. (When the store is available or unavailable to operate)STORE\_CONNECTIVITY: This event enables the health check procedurePING: Menu rejection events.MENU\_REJECTED: Menu approval events.MENU\_APPROVEDOrder Events: Order events. See ORDER\_OTHER\_EVENTCancellation Events: Order cancellation events. See ORDER\_EVENT\_CANCEL: New ordersNEW\_ORDER resource to register and test webhooks in your stores.WebhooksUse the endpoints of the&#x20;
&#x20; Important
&#x20;If you want to check the IP's from where the information is sent, you should ask your Project Manager&#x20;



Integration Standards

!!! important
This section is still under construction, and the following standards are still to be defined.

This document describes the quality and performance standards for allies to integrate with the Rappi API.

Adhering to these standards result in the best experience using the API, and ensures a successful integration with Rappi.

!!! note
The standards described in this portal are subject to change at any time.

Quality Standards

For Rappi, the best integration experience is essential in our process. For this reason, we recommend you adhere to the following practices when using the Rappi API. We continue working on help you improving the process, and as we develop new features and workflows, we continue enhancing our performance standards.

Performance Standards

The integrations with our allies must meet the following criteria:

Log in to Rappi with your token once a week to make requests.

Make requests to the Rappi API in order to get orders leaving a 45 seconds gap between requests.

!!! important
Integrations that fail to meet a 98% success rate in their API requests can be subject to revoked API access, removal, or disabling of restaurant stores from the Rappi application.

Order Integrations

The order integrations must meet the following requirements.

Requirements

These are the requirements for the order integrations.

Adhere to the order integration flow.

Reject orders through API only when you cannot process the order, and your store is affected by processing this order.

Ensure the items in your orders have the correct price.

Ensure that the totals in your orders are correct.

Ensure that the items in your orders are not out of stock.

Ensure that your orders are not missing any information, or that they contain incorrect information.


These are the requirements for the order integrations.Ensure that your orders are not missing any information, or that they contain incorrect information.Ensure that the items in your orders are not out of stock.Ensure that the totals in your orders are correct.Ensure the items in your orders have the correct price. when you cannot process the order, and your store is affected by processing this order.onlyReject orders through API Adhere to the order integration flow.


The order integrations must meet the following requirements.


The integrations with our allies must meet the following criteria:Make requests to the Rappi API in order to get orders leaving a 45 seconds gap between requests. to make requests.once a weekLog in to Rappi with your token !!! important
Integrations that fail to meet a 98% success rate in their API requests can be subject to revoked API access, removal, or disabling of restaurant stores from the Rappi application.


For Rappi, the best integration experience is essential in our process. For this reason, we recommend you adhere to the following practices when using the Rappi API. We continue working on help you improving the process, and as we develop new features and workflows, we continue enhancing our performance standards.


!!! important
This section is still under construction, and the following standards are still to be defined.This document describes the quality and performance standards for allies to integrate with the Rappi API.Adhering to these standards result in the best experience using the API, and ensures a successful integration with Rappi.!!! note
The standards described in this portal are subject to change at any time.


Store hours prevail over aisles and products hoursDo store hours prevail over products and aisles hours?Regardless if you send the information at the branch store level, the information is updated at the head store level, that is, the update is performed for the head stores, so the change is reflected both in the head store and in all branch stores associated with itIs it possible to update the schedule of aisles and products only for a branch store?Their hours will be the same as the store's schedule, therefore, the entire menu will be displayed during the store's opening hours.What if aisles and products DO NOT have a set schedule?The configuration allows the management of a calendar, that is, by days and by hours, it also includes a start time and an end time.What schedule settings can be handled?For example: if the product “Orange Juice” is included in the “Breakfast” aisle, and the product's schedule is from 7:00 am to 11:30 am and the aisle's schedule is from 8:00 am to 11:30 am, then at 7:00 am the “Breakfast” aisle is enabled and shows only the “Orange Juice” product and at 8:00 am the aisle shows the other products it contains that have the same schedule.When setting different times, the product's time prevails over the aisle time, so the aisle is enabled according to the product's time, showing only that product.What happens if you set different hours for the aisle and the product?It means that the product will be displayed in the user's app only at the configured hours.What does it mean for a product to have a schedule?The fact that an aisle has a different schedule from the store means that the aisle will only be displayed at the configured time, for example: if your store is open from 8:00 am to 6:00 pm and you have a “Breakfast” aisle with a set time from 8:00 am to 11:30 am, the aisle will only be shown at this time, even if your store is open for longerWhat happens if an aisle has a different schedule than the store?It means that the aisle will be displayed in the user's app only at the configured hours.What does it mean for an aisle to have a schedule?


API ReferenceTo get all the products and toppings statuses of a store: request to the following URL:GETMake a https://{COUNTRY\_DOMAIN}/api/rest-ops-utils/menu/integration/{integrationId}: URL: This is the identifier of your store integration.{integrationId}.See the list of Country Domains: Your Rappi Country Domain. {COUNTRY\_DOMAIN}System returns JSON response like this:{
"corridors": \[
{
"id": "1000",
"name": "Platos variados",
"description": "",
"storeId": "9000",
"integrationId": "9000"
}
],
"products": \[
{
"id": "10",
"sku": "2021",
"name": "Plato normal",
"description": "Tiene de todo",
"active": true,
"isAvailable": true,
"corridorId": "1000"
}
],
"toppingsCategories": \[
{
"id": "20",
"sku": null,
"description": "Acompañamiento",
"productId": "10",
"toppings": \[
{
"id": "341376951",
"sku": "3033",
"description": "Papas",
"activated": true
}
]
}
]
}


API ReferenceTo get all the menus statuses of a store:System returns JSON response like this: request to the following URL:GETMake a https://{COUNTRY\_DOMAIN}/api/rest-ops-utils/store/menu/{storeId}/details?from={from}\&to={to}: URL: This is the end date in format yyyy/MM/dd (this parameter is optional){to}: This is the from date in format yyyy/MM/dd (this parameter is optional){from}: This is the identifier of your store integration.{storeId}.See the list of Country Domains: Your Rappi Country Domain. {COUNTRY\_DOMAIN} parameters, it will show the data from a month ago to the current dateto or fromIn case of not sending the System returns JSON response like this:\[
{
"menu\_id": "23236",
"status": "ERROR\_MA",
"status\_description": "An error has occurred in the sent menu flow.",
"created\_at": "2021-04-29 13:41:49.389",
"updated\_at": "2021-04-29 13:42:01.024",
"error\_description": "\[Store: CO900113276]: Error finishing review. Code: 400 BAD\_REQUEST. Message: {"id":400,"message":"Estado inválido","code":"partner.menu.status.invalid"}"
},
{
"menu\_id": "23193",
"status": "APPROVED",
"status\_description": "Final status when the review is approved in the partner manager portal.",
"created\_at": "2021-04-27 17:40:32.021",
"updated\_at": "2021-04-27 17:44:00.268",
"error\_description": ""
}
]


The Utils API enables you to get all the menus of a store and check out its status


API Reference to delete a special day.DELETE store/schedule/{storeId}/special/{specialDayId}Use the endpoint To delete a special day from your store: request to the following URL.DELETEMake a https://{COUNTRY\_DOMAIN}/api/rest-ops-utils/store/schedule/{storeId}/special/{specialDayId}: URL.See the list of Country Domains: Your Rappi Country Domain. {COUNTRY\_DOMAIN}The system does not return a response, so if you receive a 200 OK status, it means that the deletion was successful.


API Reference to delete a time slot.DELETE store/schedule/{storeId}/{storeScheduleId}Use the endpoint To delete a time slot from your store: request to the following URL.DELETEMake a https://{COUNTRY\_DOMAIN}/api/rest-ops-utils/store/schedule/{storeId}/{storeScheduleId}: URL.See the list of Country Domains: Your Rappi Country Domain. {COUNTRY\_DOMAIN}The system does not return a response, so if you receive a 200 OK status, it means that the deletion was successful.


API Reference to update a time slot.PUT store/schedule/{storeId}/{storeScheduleId}Use the endpoint To update a time slot for your store: request to the following URL.PUTMake a https://{COUNTRY\_DOMAIN}/api/rest-ops-utils/store/schedule/{storeId}/{storeScheduleId}: URL.See the list of Country Domains: Your Rappi Country Domain. {COUNTRY\_DOMAIN} response like this:JSONSystem returns {
"startsTime": "07:00:00",
"endsTime": "08:00:00"
} are not real data. Ensure to replace them with your data when making API requests.JSON!!! note
The values from this  response like this:JSONSystem returns {
"day": "mon",
"storeSchedules": \[
{
"id": 1171828,
"startsTime": "07:00:00",
"endsTime": "08:00:00"
}
]
}!!! note
Given the ID of the time slot, the system will determine to which type of schedule it belongs, in this example, the system identified that this time slot belongs to the day Monday of the regular schedule


API Reference to create a time slot on a special day.POST store/schedule/{storeId}/special/{specialDayId}Use the endpoint To create a time slot on a special day: request to the following URL.POSTMake a https://{COUNTRY\_DOMAIN}/api/rest-ops-utils/store/schedule/{storeId}/special/{specialDayId}: URL.See the list of Country Domains: Your Rappi Country Domain. {COUNTRY\_DOMAIN} response like this:JSONSystem returns \[
{
"startsTime": "12:00:00",
"endsTime": "13:00:00"
},
{
"startsTime": "21:00:00",
"endsTime": "22:00:00"
}
] are not real data. Ensure to replace them with your data when making API requests.JSON!!! note
The values from this  response like this:JSONSystem returns \[
{
"id": 21126293,
"startsTime": "12:00:00",
"endsTime": "13:00:00"
},
{
"id": 21126294,
"startsTime": "21:00:00",
"endsTime": "22:00:00"
}
]


API Reference to create a special day for your store.POST store/schedule/{storeId}/specialUse the endpoint To create a special day for your store request to the following URL.POSTMake a https://{COUNTRY\_DOMAIN}/api/rest-ops-utils/store/schedule/{storeId}/special: URL.See the list of Country Domains: Your Rappi Country Domain. {COUNTRY\_DOMAIN} response like this:JSONSystem returns {
"day": 10,
"month": 10,
"name": "Special day",
"schedules": \[
{
"startsTime": "09:00:00",
"endsTime": "12:00:00"
},
{
"startsTime": "15:00:00",
"endsTime": "16:00:00"
}
]
} are not real data. Ensure to replace them with your data when making API requests.JSON!!! note
The values from this  response like this:JSONSystem returns {
"name": "Dia especial",
"month": 11,
"day": 10,
"storeSchedules": \[
{
"id": 21126295,
"startsTime": "09:00:00",
"endsTime": "12:00:00"
},
{
"id": 21126296,
"startsTime": "15:00:00",
"endsTime": "16:00:00"
}
]
}


API Reference to create a time slot on a holiday.POST store/schedule/{storeId}/holiday/{holidayDayId}Use the endpoint To create a time slot on a holiday: request to the following URL.POSTMake a https://{COUNTRY\_DOMAIN}/api/rest-ops-utils/store/schedule/{storeId}/holiday/{holidayDayId}: URL.See the list of Country Domains: Your Rappi Country Domain. {COUNTRY\_DOMAIN} response like this:JSONSystem returns \[
{
"startsTime": "10:00:00",
"endsTime": "12:00:00"
},
{
"startsTime": "13:00:00",
"endsTime": "15:00:00"
}
] are not real data. Ensure to replace them with your data when making API requests.JSON!!! note
The values from this  response like this:JSONSystem returns \[
{
"id": 21126293,
"startsTime": "10:00:00",
"endsTime": "12:00:00"
},
{
"id": 21126294,
"startsTime": "13:00:00",
"endsTime": "15:00:00"
}
]
