FAQs#

This section contains the most common questions that allies ask when integrating with the Rappi API.

Authentication#

These are the most common questions about Authentication:

What is the validity period of my access token?

Your access token has a validity of 1 week. After this time, you must generate a new token to continue making API requests to secure endpoints.

Can I use one set of Rappi OAuth credentials (client_id and client_secret) for all my stores, or do I have to generate a set of credentials per store?

You can use a set of credentials for all your stores.

Does Rappi share any of my personal information with the integration?

No. We don't share any of your personal information with the Rappi integration.

Orders#

These are the most common questions about Orders:

What type of orders do I receive when using the GET orders endpoint?

The GET orders endpoint returns only the orders that are ready to be accepted or rejected. This endpoint does not return the orders that have already been processed (accepted, rejected, or canceled due to timeout).

How much time do I have to take or reject an order?

Four minutes. After this period, Rappi cancels the order due to timeout.

Do I have to make use of the ready-for-pickup endpoint for my integration?

This endpoint is optional for your integration.

The POST orders/{orderId}/ready-for-pickup endpoint notifies the user on the Rappi application that an order is ready for pickup. You can, however, request Rappi to set this status automatically. For more information, consult the Order Status section of this site.

Do I have to provide a reason to reject an order when using the reject endpoint?

Yes. The PUT orders/{orderId}/reject endpoint requires you to provide a reason when rejecting an order.

Providing a reason gives great visibility of why the order is rejected. Optionally, you can disable items from your menu, by providing their Rappi IDs, or SKUs. See the Managing Availability section of this portal for more information.

What happens if I accept or reject and order that has already been processed?

The system returns an error message. Orders can only be processed once. After they are accepted, rejected, or canceled due to timeout, these orders cannot be modified.

Where can I find the total price of all the order products (with discounts if applicable)?

The total_products_with_discount field of the API response contains the total price of the products of the order. This total is calculated after the discounts if they exist in the order.

How do I consult the canceled orders?

You can use the GET orders/{orderId}/events endpoint to retrieve all the events of a specific order.

What are the possible reasons why a store rejects an order?

The most common reasons for stores rejecting orders are price difference, unknown SKUs, toppings in the order not corresponding to the products.

Regarding the integration, does Rappi control the delivery time of the orders?

Yes, Rappi controls the delivery time of the orders. These delivery times are automatic according to the response time of the store.

Can I consult scheduled orders?

No. The Rappi API does not support scheduled orders at the moment.

Where can I find the global discounts of the order (not the discounts per product)?

The total_other_discounts field contains the global discounts of the order.

Who assumes the discounts in the order responses, Rappi or the store?

The discounts on the responses are assumed by the store.

What is the final status of an order?

The final possible status of an order is: close_order or any canceled-related status, for example: cancel_without_charges.

Is there a way of knowing when an order is canceled without consulting each separate order?

No. Currently, the GET orders/{orderId}/events returns only a specific order per request. We recommend consulting the orders every minute or every 30 seconds.

Availability#

These are the most common questions about Availability:

After turning off an item, how long does it take to be active again?

Indefinitely. You have to enable back the item manually. See the Managing Availability section of this portal for more information.

After turning off a store, how long does it take to be active again?

Indefinitely. You have to enable back the item manually. See the Store Availability section of this portal for more information.

What is the maximum amount of items allowed to turn on and turn off per request?

You can send a maximum combined total of 100 items (turn on and turn off). The idea is that you use this endpoint PUT availability/stores/items/rappi when a product is out of stock.

When updating a menu, are disabled products enabled back in the menu?

No. You must enable products manually by using the corresponding endpoint. Managing Availability section of this portal for more information.