Order Sandbox
The sandbox lets you create test orders for your stores from the Integrations Manager portal and receive them in your integration just like a real order. A test order is not a mock: it goes through Rappi's regular order flow and reaches your integration as a NEW_ORDER event, with the same order_detail structure as a real order (see Orders).
Use it to check how your integration handles each order variant (business model, payment method, operation type, discounts and scheduled orders) before going to production.
How to create a test order
- In Integrations Manager, with the environment set to DEV, go to Orders and open the Simulator tab.
- Select the integration and the store.
- Add products from the store menu to the cart.
- In Order configuration, choose the business model, the payment method and the operation type. Optionally, add discounts or check Scheduled order.
- Click Continue, review the summary and click Create order. The portal shows you the ID of the order it created.
The order shows up in the Live tab, where you can take it and mark it as ready for pickup (see Taking the order, ready for pickup and handoff).
What you can configure and where you receive it
| Simulator option | Values | Field in order_detail |
|---|---|---|
| Business model | Full delivery, Pickup, Marketplace | delivery_method: delivery, pickup, marketplace |
| Payment method | Cash, Credit card, Rappi Pay | payment_method: cash, cc, rappi_pay_gateway |
| Operation type | Regular, Turbo | delivery_operation_type: regular, turbo |
| Delivery fee | amount | totals.charges.shipping |
| Service fee | amount | totals.charges.service_fee (see Service fee with Marketplace and online payment) |
| Scheduled order | future date and time | place_at and the NEW_ORDER_SCHEDULED event (see Scheduled orders) |
| Discounts | per-product, coupon and charge discounts | discounts[] and totals (see Discounts) |
Example of a received order
This is the order_detail the integration received for a Full delivery, Credit card, Turbo test order, with a delivery fee of 3,000 and a service fee of 5,900:
{ "order_detail": { "discounts": [], "vendors": [], "order_id": "1308613474", "cooking_time": 15, "delivery_operation_type": "turbo", "min_cooking_time": 0, "max_cooking_time": 0, "created_at": "2026-09-18 10:19:09", "place_at": null, "delivery_method": "delivery", "payment_method": "cc", "billing_information": { "billing_type": "FACTURA_ELECTRONICA", "name": "Juan Pérez", "address": null, "phone": null, "email": "juan@example.com", "document_type": "CC", "document_number": "1020304050" }, "delivery_information": null, "totals": { "total_products": 10000, "total_discounts": 0, "total_products_with_discount": 10000.00, "total_products_without_discount": 10000.00, "total_other_discounts": 0.00, "total_order": 10000.00, "total_to_pay": 0.00, "discount_by_support": 0, "total_discount_by_partner": 0, "charges": { "shipping": 3000.00, "service_fee": 5900.00 }, "other_totals": { "total_rappi_credits": 0.00, "total_rappi_pay": 0.00, "tip": 0.00 } }, "items": [ { "price": 10000.00, "toppingId": null, "categoryDescription": null, "sku": "0009", "id": "729963", "name": "Prueba 1", "type": "product", "comments": "", "unit_price_with_discount": 10000.00, "unit_price_without_discount": 10000.00, "percentage_discount": 0.00, "quantity": 1, "toppingCategoryId": null, "subitems": [] } ], "delivery_discount": null }, "customer": null, "store": { "internal_id": "900105814", "external_id": "900105814", "name": "Tienda Sin Mapeo" } }
In Full delivery orders, customer and delivery_information arrive as null. In Marketplace orders they carry the customer's data and the delivery address.
billing_information carries the billing data you enter in the Simulator. address and phone always arrive as null, in production too. If you leave billing empty, the block arrives as null; in production it can arrive as null or be missing when the user has no billing data. Your integration must handle both cases.
Turbo orders
The operation type arrives in order_detail.delivery_operation_type. An order created as Turbo arrives with "delivery_operation_type": "turbo"; all others, with "regular".
Service fee with Marketplace and online payment
This is the rule that causes the most confusion when you compare what the Simulator shows with what your integration receives:
When the order is Marketplace and the payment method is online, Rappi does not pass the service fee on to the integrator. service_fee does not appear in charges and total_order does not include it. With cash, the service fee does arrive.
Three Marketplace test orders with the same products (10,000), delivery fee (3,000) and service fee (5,900):
payment_method | totals.charges | totals.total_order |
|---|---|---|
cc | {"shipping": 3000.00} | 13000.00 |
rappi_pay_gateway | {"shipping": 3000.00} | 13000.00 |
cash | {"shipping": 3000.00, "service_fee": 5900.00} | 18900.00 |
Also keep in mind how total_order is built for each business model:
- Full delivery:
total_orderis the discounted product total. The charges arrive incharges, but they are not added (see the example:total_order10,000 with delivery fee and service fee incharges). - Marketplace:
total_orderadds the delivery fee and, only when the payment is not online, the service fee.
The Simulator warns you in the cart when the combination you picked will filter out the service fee.
Scheduled orders
Check Scheduled order and pick a future date and time. The integration receives:
- the
NEW_ORDERevent with the order and theplace_atfield, and - the
NEW_ORDER_SCHEDULEDearly notice, if the store is subscribed to that event. Its content and how to subscribe are described in Webhook Events.
The notice is only sent when place_at is a future date. The Simulator does not let you create the order with a past date.
See also the differences with production in the final note.
Discounts
Under Discounts you can add to the order:
| Type in the Simulator | discounts[].type | What you receive |
|---|---|---|
| Per-product discount | offer_by_product | An entry in discounts[] tied to the product (product_id, sku), with amount_by_rappi and amount_by_partner. A per-product discount can go up to 80%. |
| Coupon | order_discount | An entry in discounts[] for the whole order (product_id: 0, sku: null). |
| Coupon with This is a Pro Rewards coupon checked | order_discount | The same entry, with "is_pro_reward_coupon": true. |
| Delivery discount and Service fee discount (under Charge discounts) | — | They are added up in totals.total_other_discounts. |
Example: with a delivery discount of 1,000 and a service fee discount of 900, the order arrives with "total_other_discounts": 1900.00.
The partner's share of a per-product discount (amount_by_partner) is subtracted from total_products_with_discount and from total_order. A coupon is not subtracted from those totals.
Taking the order, ready for pickup and handoff
Test orders show up in the Live tab of the same portal:
- Take order moves the order to TAKEN.
- Ready for pickup moves it to READY FOR PICKUP.
- The confirmation code and the handoff QR are shown in the order details. In DEV the code is always
"0375": it is a test value, not a real one. It arrives as a string, with its leading zero, and the QR as a base64 PNG image.
The equivalent endpoints for your integration are in NEW Rest API of Orders: take, ready-for-pickup and handoff.
Known differences with production
| Topic | In the sandbox | In production |
|---|---|---|
| Rappi Credits | The Apply Rappi Credits option loads the amount into other_totals.total_rappi_credits. The Rappi/partner split shown by the Simulator is informational and is not sent. | total_rappi_credits arrives as 0. |
other_totals.total_rappi_pay | With Rappi Pay it carries the order total. | Arrives as 0. |
| Shared discounts | A discount funded by both Rappi and the partner arrives as one entry, with amount_by_rappi and amount_by_partner both above zero. | Arrives as two entries, one per funder. |
| Item prices with a per-product discount | unit_price_with_discount and percentage_discount arrive undiscounted. | They arrive discounted by the partner's share. |
Fixed amount (value) and percentage over products (percentage) | value is subtracted from total_products_with_discount and total_order; percentage is not. | The partner's share of percentage is subtracted; value is not. |
total_discount_by_partner | Only adds up per-product and fixed-amount discounts. | Adds up the partner's share of every discount, coupons included. |
Scheduled orders: NEW_ORDER | Arrives when the order is created, together with the NEW_ORDER_SCHEDULED notice. | Arrives when the order is released to the store. |
Scheduled orders: place_at format | ISO 8601 in UTC, for example 2026-09-19T16:00:00.000Z. | Store local time, yyyy-MM-dd HH:mm:ss. |
