Documentation

Orders

The Orders resource enables you to interact with the orders of your stores.

The following table describes the different contents of the Orders resource:

ResourceDescription
GET restaurants/orders/v1/ordersReturns a list of new orders created from specific clientId.
GET restaurants/orders/v1/stores/{storeId}/ordersReturns a list of new orders created from specific storeId.
GET restaurants/orders/v1/orders/status/sentReturns a list of new orders created in SENT.
PUT restaurants/orders/v1/stores/{storeId}/orders/{orderId}/takeTakes an order to commence preparation.
PUT restaurants/orders/v1/stores/{storeId}/orders/{orderId}/cooking_time/{cookingTime}/takeTakes an order to commence preparation with the new cooking time of the order.
GET restaurants/orders/v1/stores/{storeId}/orders/{orderId}/handoffReturn the confirmation code and the QR code of the order.
POST restaurants/orders/v1/stores/{storeId}/orders/{orderId}/bag-drink-confirmationConfirm the number of bags and if there are drinks outside the bags in the order.
POST restaurants/orders/v1/stores/{storeId}/orders/{orderId}/ready-for-pickupConfirms that the order is ready for pickup.
PUT restaurants/orders/v1/stores/{storeId}/orders/{orderId}/cancel_type/{cancelType}/rejectReject an order to start its preparation with the new cooking time.

GET orders

Use this endpoint to return a collection of all the new orders for the stores of the authenticating ally.

Endpoint URL

Use this URL to make a request with this endpoint:

https://{COUNTRY_DOMAIN}/restaurants/orders/v1/orders

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

GET https://api.dev.rappi.com/restaurants/orders/v1/orders

this is an example of the request:

URL url = new URL("https://api.dev.rappi.com/restaurants/orders/v1/orders");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());






Sample Response




This is an example of the response:




[
  {
    "order_detail": {
      "order_id": "string",
      "delivery_operation_type": "string",
      "cooking_time": 0,
      "min_cooking_time": 0,
      "max_cooking_time": 0,
      "created_at": "string",
      "delivery_method": "string",
      "payment_method": "string",
      "billing_information": {
        "billing_type": "string",
        "name": "string",
        "address": "string",
        "phone": "string",
        "email": "string",
        "document_type": "string",
        "document_number": "string"
      },
      "delivery_information": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "totals": {
        "total_products": 0,
        "total_discounts": 0,
        "total_products_with_discount": 0,
        "total_products_without_discount": 0,
        "total_other_discounts": 0,
        "total_order": 0,
        "total_to_pay": 0,
        "discount_by_support": 0,
        "totals_discount_by_partner": 0,
        "charges": {
          "additionalProp1": 0,
          "additionalProp2": 0,
          "additionalProp3": 0
        },
        "other_totals": {
          "additionalProp1": 0,
          "additionalProp2": 0,
          "additionalProp3": 0
        }
      },
      "items": [
        {
          "sku": "string",
          "id": "string",
          "name": "string",
          "type": "string",
          "comments": "string",
          "unit_price_with_discount": 0,
          "unit_price_without_discount": 0,
          "price": 0,
          "percentage_discount": 0,
          "quantity": 0,
          "subitems": ["string"]
        }
      ],
      "delivery_discount": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      },
      "discounts": [
        {
          "value": 0,
          "description": "string",
          "tittle": "string",
          "product_id": 0,
          "type": "string",
          "raw_value": 0,
          "value_type": "string",
          "max_value": 0,
          "includes_toppings": true,
          "percentage_by_rappi": 0,
          "percentage_by_partners": 0,
          "amount_by_rappi": 0,
          "amount_by_partner": 0,
          "discount_product_units": 0,
          "discount_product_unit_value": 0,
          "sku": "string"
        }
      ]
    },
    "customer": {
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "user_type": "string",
      "email": "string",
      "document_type": "string",
      "document_number": "string"
    },
    "store": {
      "internal_id": "string",
      "external_id": "string",
      "name": "string"
    }
  }
]


This table describes the objects contained in the response example:



























































































































































































































































































































































Response ObjectObject Description
order_detail
array of objects		Properties of the details of the order.
order_detail.order_id
string		Order identifier.
order_detail.develivey_operation_type
string		Identifier for the order type: turbo type or regular type.
order_detail.coooking_time
integer		Cooking time estimated for the preparation of the order.
order_detail.min_cooking_time
integer		Minimum cooking time in minutes set for this order.
order_detail.max_cooking_time
integer		Maximum cooking time in minutes set for this order.
order_detail.created_at
string		Creation date of the order.
order_detail.delivery_method
string, enumerable		Delivery method set for this order. Options available: delivery,marketplace, pickup.
order_detail.payment_method
string, enumerable		Payment method set for this order. Options available: rappi_pay, cc, cash, paypal, edenred, webpay, masterpass, dc, pos_terminal, elo, sodexo, vale_r, ticket_r, alelo, visa_checkout,google_pay, apple_pay, rappicorp, PSE, PIX, unknown. (You have to consider, Rappi frequently includes new payment methods, so this list may vary through time and isn't needs to be validated.)
order_detail.delivery_information
object		Properties of the delivery information.
order_detail.delivery_information.city
string		City of the delivery address.
order_detail.delivery_information.complete_address
string		Delivery address with all the fields
order_detail.delivery_information.street_number
string		Number of the street.
order_detail.delivery_information.neighborhood
string		Neighborhood of the address.
order_detail.delivery_information.complement
string		Additional information of the address.
order_detail.delivery_information.postal_code
string		Postal code of the address
order_detail.delivery_information.street_name
string		Street name of the address.
order_detail.billing_information
array of objects		Properties of the billing information.
order_detail.billing_information.address
string		Delivery address set for this order.
order_detail.billing_information.billing_type
string		Billing type set for this order.
order_detail.billing_information.document_number
string		Document number of the customer.
order_detail.billing_information.document_type
string		Document type of the customer.
order_detail.billing_information.email
string		Email set to receive billing information.
order_detail.billing_information.name
string		Name set for the billing information.
order_detail.billing_information.phone
string		Phone number set for the billing information.
order_detail.totals
array of objects		Properties of the totals of the order.
order_detail.totals.total_products
integer		Total products without discounts.
order_detail.totals.total_discounts
integer		Total products without discount in the order.
order_detail.totals.total_order
integer		The total amount that the restaurant receives.
When the delivery method is marketplace this field includes tip and delivery fee.
For other delivery methods, this field contains only the total value of all products.
In all cases, this field includes the discounts assumed by the restaurant.
order_detail.totals.total_to_pay
integer		Total that the user pays in cash to the courier. Only applies when the delivery method is marketplace or pickup, and the payment method is cash.
order_detail.totals.discount_by_support
integer		Discount applied to the customer by the Rappi support team.
order_detail.totals.charges
array of objects		Properties of the order additional charges.
order_detail.totals.charges.shipping
integer		Shipping charges total.
order_detail.totals.charges.service_fee
integer		Rappi service fee charges
order_detail.totals.other_totals
array of objects		Other charges included in this order.
order_detail.totals.other_totals.tip
integer		Tip for the courier.
order_detail.totals.other_totals.total_rappi_pay
integer		Total paid using Rappi Pay.
order_detail.totals.othet_totals.total_rappi_credits
integer		Total paid using Rappi Credits.
order_detail.items
array of objects		Properties of the items the order contains.
order_detail.items.sku
string		SKU for the item in the order. The ally grants their own SKU to the item.
order_detail.items.id
string		Identifier of the item in the order.
order_detail.items.name
string		Name of the item in the order.
order_detail.items.type
string, enumerable		Type of the item. Options available: 
product, or topping.
order_detail.items.comments
array		User comments for the items in the order.
order_detail.items.price
integer		Unit price for the item without the discount.
order_detail.items.percentage_discount
integer		Discount percentage of the item in the order.
order_detail.items.quantity
integer		Quantity specified for this item in the order.
order_detail.items.subitems
array of objects		Properties of subitems in the order.
order_detail.items.subitems.sku
string		SKU for the subitem in the menu. The ally grants their own SKU to the item.
order_detail.items.subitems.id
string		The identifier that Rappi grants the item.
order_detail.items.subitems.name
string		Name of the subitem in the order.
order_detail.items.subitems.type
string, enumerable		Type of the subitem in the order. Options available: product, or topping.
order_detail.items.subitems.price
integer		Unit price for the subitem without the discount.
order_detail.items.subitems.pencentage_discount
integer		Discount percentage of the subitem in the order.
order_detail.items.subitems.quantity
integer		Quantity specified for this subitem in the order.
order_detail.delivery_discount
integer		Properties of the discounts in the delivery of the order.
order_detail.delivery_discount.total_percentage_discount
integer		Discount percentage in the delivery of the order.
order_detail.delivery_discount.total_value_discount
integer		Total amount of the delivery discount.
order_detail.customer
array of objects		Properties of the Rappi user that places the order. Only sent when delivery method is marketplace or if you request Rappi to receive this data.
order_detail.customer.first_name
string		First name of the Rappi user that places the order.
order_detail.customer.last_name
string		Last name of the Rappi user that places the order.
order_detail.customer.phone_number
string		Phone number of the Rappi user that places the order.
order_detail.customer.document_number
string		Document number of the Rappi user that places the order.
order_detail.customer.user_type
string		If the user is VIP the value is USER_VIP. For other users this field is not sent.
order_detail.store
array of objects		Properties of the store that prepares the order.
order_detail.store.internal_id
string		Internal identifier that Rappi grants the store.
order_detail.store.external_id
string		Integration identifier of the store.
order_detail.store.name
string		Name of the store that prepares the order.
order_detail.discounts.value
integer		Discount value in currency.
order_detail.discounts.description
string		Descriptive message explaining the discount.
order_detail.discounts.title
string		Discount name.
order_detail.discounts.product_id
integer		Product ID if the discount applies product.
order_detail.discounts.sku
string		SKU of the product if the discount applies product.
order_detail.discounts.type
string		Indicates the discount type.
order_detail.discounts.raw_value
integer		The discount value can represent a percentage or a currency value depending on the type_value.
order_detail.discounts.value_type
string, enumerable		The value type of the discount. Available options: value, percentage.
order_detail.discounts.max_value
integer		Maximum value in currency to be discounted.
order_detail.discounts.includes_toppings
boolean		Indicates if the discount is subtracted from the product total with toppings or not.
order_detail.discounts.percentage_by_rappi
integer		The percentage of the discount assumed by Rappi.
order_detail.discounts.percentage_by_partners
integer		The percentage of the discount assumed by the partner.
order_detail.discounts.amount_by_rappi
integer		Value of the discount in currency assumed by Rappi.
order_detail.discounts.amount_by_partner
integer		Value of the discount in currency assumed by the partner.
order_detail.discounts.discount_product_units
integer		Number of products to which the discount was applied.
order_detail.discounts.discount_product_unit_value
integer		Discount value per product unit.


GET stores/{storeId}/orders


Use this endpoint to return a collection of all the new orders for the specific storeId of the authenticating ally.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders


{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.


{storeId}: This is the identifier of the store.



Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


Status Codes


These are the possible status codes of the response for this endpoint:




Sample Request


This is an example of an API request using this endpoint:


GET https://api.dev.rappi.com/restaurants/orders/v1/stores/205634/orders




this is an example of the request:




final Integer storeId = 205634;

URL url = new URL("https://api.dev.rappi.com/restaurants/orders/v1/stores/%s/orders", storeId);

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());








Sample Response




This is an example of the response:




[
  {
    "order_detail": {
      "order_id": "string",
      "delivery_operation_type": "string",
      "cooking_time": 0,
      "min_cooking_time": 0,
      "max_cooking_time": 0,
      "created_at": "string",
      "delivery_method": "string",
      "payment_method": "string",
      "billing_information": {
        "billing_type": "string",
        "name": "string",
        "address": "string",
        "phone": "string",
        "email": "string",
        "document_type": "string",
        "document_number": "string"
      },
      "delivery_information": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "totals": {
        "total_products": 0,
        "total_discounts": 0,
        "total_products_with_discount": 0,
        "total_products_without_discount": 0,
        "total_other_discounts": 0,
        "total_order": 0,
        "total_to_pay": 0,
        "discount_by_support": 0,
        "totals_discount_by_partner": 0,
        "charges": {
          "additionalProp1": 0,
          "additionalProp2": 0,
          "additionalProp3": 0
        },
        "other_totals": {
          "additionalProp1": 0,
          "additionalProp2": 0,
          "additionalProp3": 0
        }
      },
      "items": [
        {
          "sku": "string",
          "id": "string",
          "name": "string",
          "type": "string",
          "comments": "string",
          "unit_price_with_discount": 0,
          "unit_price_without_discount": 0,
          "price": 0,
          "percentage_discount": 0,
          "quantity": 0,
          "subitems": ["string"]
        }
      ],
      "delivery_discount": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      },
      "discounts": [
        {
          "value": 0,
          "description": "string",
          "tittle": "string",
          "product_id": 0,
          "type": "string",
          "raw_value": 0,
          "value_type": "string",
          "max_value": 0,
          "includes_toppings": true,
          "percentage_by_rappi": 0,
          "percentage_by_partners": 0,
          "amount_by_rappi": 0,
          "amount_by_partner": 0,
          "discount_product_units": 0,
          "discount_product_unit_value": 0,
          "sku": "string"
        }
      ]
    },
    "customer": {
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "user_type": "string",
      "email": "string",
      "document_type": "string",
      "document_number": "string"
    },
    "store": {
      "internal_id": "string",
      "external_id": "string",
      "name": "string"
    }
  }
]


This table describes the objects contained in the response example:



























































































































































































































































































































































Response ObjectObject Description
order_detail
array of objects		Properties of the details of the order.
order_detail.order_id
string		Order identifier.
order_detail.develivey_operation_type
string		Identifier for the order type: turbo type or regular type.
order_detail.coooking_time
integer		Cooking time estimated for the preparation of the order.
order_detail.min_cooking_time
integer		Minimum cooking time in minutes set for this order.
order_detail.max_cooking_time
integer		Maximum cooking time in minutes set for this order.
order_detail.created_at
string		Creation date of the order.
order_detail.delivery_method
string, enumerable		Delivery method set for this order. Options available: delivery,marketplace, pickup.
order_detail.payment_method
string, enumerable		Payment method set for this order. Options available: rappi_pay, cc, cash, paypal, edenred, webpay, masterpass, dc, pos_terminal, elo, sodexo, vale_r, ticket_r, alelo, visa_checkout,google_pay, apple_pay, rappicorp, PSE, PIX, unknown. (You have to consider, Rappi frequently includes new payment methods, so this list may vary through time and isn't needs to be validated.)
order_detail.delivery_information
object		Properties of the delivery information.
order_detail.delivery_information.city
string		City of the delivery address.
order_detail.delivery_information.complete_address
string		Delivery address with all the fields
order_detail.delivery_information.street_number
string		Number of the street.
order_detail.delivery_information.neighborhood
string		Neighborhood of the address.
order_detail.delivery_information.complement
string		Additional information of the address.
order_detail.delivery_information.postal_code
string		Postal code of the address
order_detail.delivery_information.street_name
string		Street name of the address.
order_detail.billing_information
array of objects		Properties of the billing information.
order_detail.billing_information.address
string		Delivery address set for this order.
order_detail.billing_information.billing_type
string		Billing type set for this order.
order_detail.billing_information.document_number
string		Document number of the customer.
order_detail.billing_information.document_type
string		Document type of the customer.
order_detail.billing_information.email
string		Email set to receive billing information.
order_detail.billing_information.name
string		Name set for the billing information.
order_detail.billing_information.phone
string		Phone number set for the billing information.
order_detail.totals
array of objects		Properties of the totals of the order.
order_detail.totals.total_products
integer		Total products without discounts.
order_detail.totals.total_discounts
integer		Total products without discount in the order.
order_detail.totals.total_order
integer		The total amount that the restaurant receives.
When the delivery method is marketplace this field includes tip and delivery fee.
For other delivery methods, this field contains only the total value of all products.
In all cases, this field includes the discounts assumed by the restaurant.
order_detail.totals.total_to_pay
integer		Total that the user pays in cash to the courier. Only applies when the delivery method is marketplace or pickup, and the payment method is cash.
order_detail.totals.discount_by_support
integer		Discount applied to the customer by the Rappi support team.
order_detail.totals.charges
array of objects		Properties of the order additional charges.
order_detail.totals.charges.shipping
integer		Shipping charges total.
order_detail.totals.charges.service_fee
integer		Rappi service fee charges
order_detail.totals.other_totals
array of objects		Other charges included in this order.
order_detail.totals.other_totals.tip
integer		Tip for the courier.
order_detail.totals.other_totals.total_rappi_pay
integer		Total paid using Rappi Pay.
order_detail.totals.othet_totals.total_rappi_credits
integer		Total paid using Rappi Credits.
order_detail.items
array of objects		Properties of the items the order contains.
order_detail.items.sku
string		SKU for the item in the order. The ally grants their own SKU to the item.
order_detail.items.id
string		Identifier of the item in the order.
order_detail.items.name
string		Name of the item in the order.
order_detail.items.type
string, enumerable		Type of the item. Options available: 
product, or topping.
order_detail.items.comments
array		User comments for the items in the order.
order_detail.items.price
integer		Unit price for the item without the discount.
order_detail.items.percentage_discount
integer		Discount percentage of the item in the order.
order_detail.items.quantity
integer		Quantity specified for this item in the order.
order_detail.items.subitems
array of objects		Properties of subitems in the order.
order_detail.items.subitems.sku
string		SKU for the subitem in the menu. The ally grants their own SKU to the item.
order_detail.items.subitems.id
string		The identifier that Rappi grants the item.
order_detail.items.subitems.name
string		Name of the subitem in the order.
order_detail.items.subitems.type
string, enumerable		Type of the subitem in the order. Options available: product, or topping.
order_detail.items.subitems.price
integer		Unit price for the subitem without the discount.
order_detail.items.subitems.pencentage_discount
integer		Discount percentage of the subitem in the order.
order_detail.items.subitems.quantity
integer		Quantity specified for this subitem in the order.
order_detail.delivery_discount
integer		Properties of the discounts in the delivery of the order.
order_detail.delivery_discount.total_percentage_discount
integer		Discount percentage in the delivery of the order.
order_detail.delivery_discount.total_value_discount
integer		Total amount of the delivery discount.
order_detail.customer
array of objects		Properties of the Rappi user that places the order. Only sent when delivery method is marketplace or if you request Rappi to receive this data.
order_detail.customer.first_name
string		First name of the Rappi user that places the order.
order_detail.customer.last_name
string		Last name of the Rappi user that places the order.
order_detail.customer.phone_number
string		Phone number of the Rappi user that places the order.
order_detail.customer.document_number
string		Document number of the Rappi user that places the order.
order_detail.customer.user_type
string		If the user is VIP the value is USER_VIP. For other users this field is not sent.
order_detail.store
array of objects		Properties of the store that prepares the order.
order_detail.store.internal_id
string		Internal identifier that Rappi grants the store.
order_detail.store.external_id
string		Integration identifier of the store.
order_detail.store.name
string		Name of the store that prepares the order.
order_detail.discounts.value
integer		Discount value in currency.
order_detail.discounts.description
string		Descriptive message explaining the discount.
order_detail.discounts.title
string		Discount name.
order_detail.discounts.product_id
integer		Product ID if the discount applies product.
order_detail.discounts.sku
string		SKU of the product if the discount applies product.
order_detail.discounts.type
string		Indicates the discount type.
order_detail.discounts.raw_value
integer		The discount value can represent a percentage or a currency value depending on the type_value.
order_detail.discounts.value_type
string, enumerable		The value type of the discount. Available options: value, percentage.
order_detail.discounts.max_value
integer		Maximum value in currency to be discounted.
order_detail.discounts.includes_toppings
boolean		Indicates if the discount is subtracted from the product total with toppings or not.
order_detail.discounts.percentage_by_rappi
integer		The percentage of the discount assumed by Rappi.
order_detail.discounts.percentage_by_partners
integer		The percentage of the discount assumed by the partner.
order_detail.discounts.amount_by_rappi
integer		Value of the discount in currency assumed by Rappi.
order_detail.discounts.amount_by_partner
integer		Value of the discount in currency assumed by the partner.
order_detail.discounts.discount_product_units
integer		Number of products to which the discount was applied.
order_detail.discounts.discount_product_unit_value
integer		Discount value per product unit.


GET orders/status/sent


Use this endpoint to return a collection of all the new orders status SENT for the stores of the authenticating ally.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{COUNTRY_DOMAIN}/restaurants/orders/v1/orders/status/sent


{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.



Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


Status Codes


These are the possible status codes of the response for this endpoint:




Sample Request


This is an example of an API request using this endpoint:


GET https://api.dev.rappi.com/restaurants/orders/v1/orders/status/sent




this is an example of the request:




URL url = new URL("https://api.dev.rappi.com/restaurants/orders/v1/orders/status/sent");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());








Sample Response




This is an example of the response:




[
  {
    "order_detail": {
      "order_id": "string",
      "delivery_operation_type": "string",
      "cooking_time": 0,
      "min_cooking_time": 0,
      "max_cooking_time": 0,
      "created_at": "string",
      "delivery_method": "string",
      "payment_method": "string",
      "billing_information": {
        "billing_type": "string",
        "name": "string",
        "address": "string",
        "phone": "string",
        "email": "string",
        "document_type": "string",
        "document_number": "string"
      },
      "delivery_information": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "totals": {
        "total_products": 0,
        "total_discounts": 0,
        "total_products_with_discount": 0,
        "total_products_without_discount": 0,
        "total_other_discounts": 0,
        "total_order": 0,
        "total_to_pay": 0,
        "discount_by_support": 0,
        "totals_discount_by_partner": 0,
        "charges": {
          "additionalProp1": 0,
          "additionalProp2": 0,
          "additionalProp3": 0
        },
        "other_totals": {
          "additionalProp1": 0,
          "additionalProp2": 0,
          "additionalProp3": 0
        }
      },
      "items": [
        {
          "sku": "string",
          "id": "string",
          "name": "string",
          "type": "string",
          "comments": "string",
          "unit_price_with_discount": 0,
          "unit_price_without_discount": 0,
          "price": 0,
          "percentage_discount": 0,
          "quantity": 0,
          "subitems": ["string"]
        }
      ],
      "delivery_discount": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      },
      "discounts": [
        {
          "value": 0,
          "description": "string",
          "tittle": "string",
          "product_id": 0,
          "type": "string",
          "raw_value": 0,
          "value_type": "string",
          "max_value": 0,
          "includes_toppings": true,
          "percentage_by_rappi": 0,
          "percentage_by_partners": 0,
          "amount_by_rappi": 0,
          "amount_by_partner": 0,
          "discount_product_units": 0,
          "discount_product_unit_value": 0,
          "sku": "string"
        }
      ]
    },
    "customer": {
      "first_name": "string",
      "last_name": "string",
      "phone_number": "string",
      "user_type": "string",
      "email": "string",
      "document_type": "string",
      "document_number": "string"
    },
    "store": {
      "internal_id": "string",
      "external_id": "string",
      "name": "string"
    }
  }
]


This table describes the objects contained in the response example:



























































































































































































































































































































































Response ObjectObject Description
order_detail
array of objects		Properties of the details of the order.
order_detail.order_id
string		Order identifier.
order_detail.develivey_operation_type
string		Identifier for the order type: turbo type or regular type.
order_detail.coooking_time
integer		Cooking time estimated for the preparation of the order.
order_detail.min_cooking_time
integer		Minimum cooking time in minutes set for this order.
order_detail.max_cooking_time
integer		Maximum cooking time in minutes set for this order.
order_detail.created_at
string		Creation date of the order.
order_detail.delivery_method
string, enumerable		Delivery method set for this order. Options available: delivery,marketplace, pickup.
order_detail.payment_method
string, enumerable		Payment method set for this order. Options available: rappi_pay, cc, cash, paypal, edenred, webpay, masterpass, dc, pos_terminal, elo, sodexo, vale_r, ticket_r, alelo, visa_checkout,google_pay, apple_pay, rappicorp, PSE, PIX, unknown.
order_detail.delivery_information
object		Properties of the delivery information.
order_detail.delivery_information.city
string		City of the delivery address.
order_detail.delivery_information.complete_address
string		Delivery address with all the fields
order_detail.delivery_information.street_number
string		Number of the street.
order_detail.delivery_information.neighborhood
string		Neighborhood of the address.
order_detail.delivery_information.complement
string		Additional information of the address.
order_detail.delivery_information.postal_code
string		Postal code of the address
order_detail.delivery_information.street_name
string		Street name of the address.
order_detail.billing_information
array of objects		Properties of the billing information.
order_detail.billing_information.address
string		Delivery address set for this order.
order_detail.billing_information.billing_type
string		Billing type set for this order.
order_detail.billing_information.document_number
string		Document number of the customer.
order_detail.billing_information.document_type
string		Document type of the customer.
order_detail.billing_information.email
string		Email set to receive billing information.
order_detail.billing_information.name
string		Name set for the billing information.
order_detail.billing_information.phone
string		Phone number set for the billing information.
order_detail.totals
array of objects		Properties of the totals of the order.
order_detail.totals.total_products
integer		Total products without discounts.
order_detail.totals.total_discounts
integer		Total products without discount in the order.
order_detail.totals.total_order
integer		The total amount that the restaurant receives.
When the delivery method is marketplace this field includes tip and delivery fee.
For other delivery methods, this field contains only the total value of all products.
In all cases, this field includes the discounts assumed by the restaurant.
order_detail.totals.total_to_pay
integer		Total that the user pays in cash to the courier. Only applies when the delivery method is marketplace or pickup, and the payment method is cash.
order_detail.totals.discount_by_support
integer		Discount applied to the customer by the Rappi support team.
order_detail.totals.charges
array of objects		Properties of the order additional charges.
order_detail.totals.charges.shipping
integer		Shipping charges total.
order_detail.totals.charges.service_fee
integer		Rappi service fee charges
order_detail.totals.other_totals
array of objects		Other charges included in this order.
order_detail.totals.other_totals.tip
integer		Tip for the courier.
order_detail.totals.other_totals.total_rappi_pay
integer		Total paid using Rappi Pay.
order_detail.totals.othet_totals.total_rappi_credits
integer		Total paid using Rappi Credits.
order_detail.items
array of objects		Properties of the items the order contains.
order_detail.items.sku
string		SKU for the item in the order. The ally grants their own SKU to the item.
order_detail.items.id
string		Identifier of the item in the order.
order_detail.items.name
string		Name of the item in the order.
order_detail.items.type
string, enumerable		Type of the item. Options available: 
product, or topping.
order_detail.items.comments
array		User comments for the items in the order.
order_detail.items.price
integer		Unit price for the item without the discount.
order_detail.items.percentage_discount
integer		Discount percentage of the item in the order.
order_detail.items.quantity
integer		Quantity specified for this item in the order.
order_detail.items.subitems
array of objects		Properties of subitems in the order.
order_detail.items.subitems.sku
string		SKU for the subitem in the menu. The ally grants their own SKU to the item.
order_detail.items.subitems.id
string		The identifier that Rappi grants the item.
order_detail.items.subitems.name
string		Name of the subitem in the order.
order_detail.items.subitems.type
string, enumerable		Type of the subitem in the order. Options available: product, or topping.
order_detail.items.subitems.price
integer		Unit price for the subitem without the discount.
order_detail.items.subitems.pencentage_discount
integer		Discount percentage of the subitem in the order.
order_detail.items.subitems.quantity
integer		Quantity specified for this subitem in the order.
order_detail.delivery_discount
integer		Properties of the discounts in the delivery of the order.
order_detail.delivery_discount.total_percentage_discount
integer		Discount percentage in the delivery of the order.
order_detail.delivery_discount.total_value_discount
integer		Total amount of the delivery discount.
order_detail.customer
array of objects		Properties of the Rappi user that places the order. Only sent when delivery method is marketplace or if you request Rappi to receive this data.
order_detail.customer.first_name
string		First name of the Rappi user that places the order.
order_detail.customer.last_name
string		Last name of the Rappi user that places the order.
order_detail.customer.phone_number
string		Phone number of the Rappi user that places the order.
order_detail.customer.document_number
string		Document number of the Rappi user that places the order.
order_detail.customer.user_type
string		If the user is VIP the value is USER_VIP. For other users this field is not sent.
order_detail.store
array of objects		Properties of the store that prepares the order.
order_detail.store.internal_id
string		Internal identifier that Rappi grants the store.
order_detail.store.external_id
string		Integration identifier of the store.
order_detail.store.name
string		Name of the store that prepares the order.
order_detail.discounts.value
integer		Discount value in currency.
order_detail.discounts.description
string		Descriptive message explaining the discount.
order_detail.discounts.title
string		Discount name.
order_detail.discounts.product_id
integer		Product ID if the discount applies product.
order_detail.discounts.sku
string		SKU of the product if the discount applies product.
order_detail.discounts.type
string		Indicates the discount type.
order_detail.discounts.raw_value
integer		The discount value can represent a percentage or a currency value depending on the type_value.
order_detail.discounts.value_type
string, enumerable		The value type of the discount. Available options: value, percentage.
order_detail.discounts.max_value
integer		Maximum value in currency to be discounted.
order_detail.discounts.includes_toppings
boolean		Indicates if the discount is subtracted from the product total with toppings or not.
order_detail.discounts.percentage_by_rappi
integer		The percentage of the discount assumed by Rappi.
order_detail.discounts.percentage_by_partners
integer		The percentage of the discount assumed by the partner.
order_detail.discounts.amount_by_rappi
integer		Value of the discount in currency assumed by Rappi.
order_detail.discounts.amount_by_partner
integer		Value of the discount in currency assumed by the partner.
order_detail.discounts.discount_product_units
integer		Number of products to which the discount was applied.
order_detail.discounts.discount_product_unit_value
integer		Discount value per product unit.


PUT stores/{storeId}/orders/{orderId}/take


Use this endpoint to take an order, so the store commences preparing it.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/take


{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.


{storeId}: This is the identifier of the store.


{orderId}: This is the identifier of the order.



Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


Status Codes


These are the possible status codes of the response for this endpoint:






Sample Request


This is an example of an API request using this endpoint:


PUT https://api.dev.rappi.com/restaurants/orders/v1/stores/392625/orders/203654/take




this is an example of the request:




final Integer storeId = 392625;
final Integer orderId = 203654;

URL url = new URL(String.format("https://api.dev.rappi.com/restaurants/orders/v1/stores/%s/orders/%s/take", storeId, orderId));

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("PUT");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");
connection.setDoOutput(true);

System.out.println("Response Code : " + connection.getResponseCode());








Sample Response


This endpoint returns a status response code only.


PUT stores/{storeId}/orders/{orderId}/cooking_time/{cookingTime}/take


Use this endpoint to take an order, so the store commences preparing it.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/cooking_time/{cookingTime}/take


{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.


{storeId}: This is the identifier of the store.


{orderId}: This is the identifier of the order.


{cookingTime}: This is the new cooking time of the order.



Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


Status Codes


These are the possible status codes of the response for this endpoint:






Sample Request


This is an example of an API request using this endpoint:


PUT https://api.dev.rappi.com/restaurants/orders/v1/stores/205643/orders/392625/cooking_time/20/take




this is an example of the request:




final Integer storeId = 205643;
final Integer orderId = 392625;
final Integer cookingTime = 20;

URL url = new URL(String.format("https://api.dev.rappi.com/restaurants/orders/v1/stores/%s/orders/%s/cooking_time/%s/take", storeId, orderId, cookingTime));

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("PUT");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");
connection.setDoOutput(true);

System.out.println("Response Code : " + connection.getResponseCode());








Sample Response


This endpoint returns a status response code only.


GET stores/{storeId}/orders/{orderId}/handoff


Use this endpoint to take an order so that the store can start preparing it.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/handoff


{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.


{storeId}: This is the identifier of the store.


{orderId}: This is the identifier of the order.



Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


Status Codes


These are the possible status codes of the response for this endpoint:






Sample Request


This is an example of an API request using this endpoint:


GET https://api.dev.rappi.com/restaurants/orders/v1/stores/392625/orders/203654/handoff




This is an example of the request:




final Integer storeId = 392625;
final Integer orderId = 203654;

URL url = new URL(String.format("https://api.dev.rappi.com/restaurants/orders/v1/stores/%s/orders/%s/handoff", storeId, orderId));

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");
connection.setDoOutput(true);

System.out.println("Response Code : " + connection.getResponseCode());








Sample Response




This is an example of the response:




{
  "order_id": 2150145112,
  "store_id": 900126924,
  "product_confirmation_code": "3756",
  "qr_code": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAIAAAAiOjnJAAALRklEQVR4Xu2SQZJjOxLD+v6X/rOHsGAoxLRrnFhWgGT6lf79tywF/vEPy/KCfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4V9WEuFfVhLhX1YS4Xph/Xvo/Ca5j1cam4l8Joy43sfhdc07+FScyuB15QZ3/sovKZ5D5eaWwm8psz43kfhNc17uNTcSuA1Zcb3Pgqvad7DpeZWAq8pM773UXhN8x4uNbcSeE2Z8b0DGu/gUrbFjKVomHPCTJa6g0vNLWV874DGO7iUbTFjKRrmnDCTpe7gUnNLGd87oPEOLmVbzFiKhjknzGSpO7jU3FLG9w5ovINL2RYzlqJhzgkzWeoOLjW3lPG9Axrv4FK2xYylaJhzwkyWuoNLzS1lfO+Axju4lG0xYyka5pwwk6Xu4FJzSxnfO6BhTgJbrIeGwYzBTAZbrIdGBlush0aZ8b0DGuYksMV6aBjMGMxksMV6aGSwxXpolBnfO6BhTgJbrIeGwYzBTAZbrIdGBlush0aZ8b0DGuYksMV6aBjMGMxksMV6aGSwxXpolBnfO6BhTgJbrIeGwYzBTAZbrIdGBlush0aZ8b0DGuYksMV6aBjMGMxksMV6aGSwxXpolBnfO6BhTgJbrIeGwUwGWwxmLEUjgy3WQ6PM+N4BDXMS2GI9NAxmMthiMGMpGhlssR4aZcb3DmiYk8AW66FhMJPBFoMZS9HIYIv10CgzvndAw5wEtlgPDYOZDLYYzFiKRgZbrIdGmfG9AxrmJLDFemgYzGSwxWDGUjQy2GI9NMqM7x3QMCeBLdZDw2Amgy0GM5aikcEW66FRZnzvgIY5CWyxHhoZbLEeGu+cBLZYD40y43sHNMxJYIv10Mhgi/XQeOcksMV6aJQZ3zugYU4CW6yHRgZbrIfGOyeBLdZDo8z43gENcxLYYj00MthiPTTeOQlssR4aZcb3DmiYk8AW66GRwRbrofHOSWCL9dAoM753QMOcBLZYD40MtlgPjXdOAlush0aZ8b0DGu/g0rst9hrMWIrGO7jU3FLG9w5ovINL77bYazBjKRrv4FJzSxnfO6DxDi6922KvwYylaLyDS80tZXzvgMY7uPRui70GM5ai8Q4uNbeU8b0DGu/g0rst9hrMWIrGO7jU3FLG9w5ovINL77bYazBjKRrv4FJzSxnf+yi8xu6h0XQm4TVlxvc+Cq+xe2g0nUl4TZnxvY/Ca+weGk1nEl5TZnzvo/Aau4dG05mE15QZ3/sovMbuodF0JuE1Zcb3PgqvsXtoNJ1JeE2Z6b1vg5//HVz6MX7+99fg0o/x87+/Bpd+jJ///TW49GP8/O+vwaUf4+d/fw0u/RjTv5+f32DmXYqGwYzBjKVoZM4ruNTcUsb3Aph5l6JhMGMwYykamfMKLjW3lPG9AGbepWgYzBjMWIpG5ryCS80tZXwvgJl3KRoGMwYzlqKROa/gUnNLGd8LYOZdiobBjMGMpWhkziu41NxSxvcCmHmXomEwYzBjKRqZ8wouNbeU8b0r2GI9NAxmLEXDYMZSNG6dO9g7zvQF/AAZbLEeGgYzlqJhMGMpGrfOHewdZ/oCfoAMtlgPDYMZS9EwmLEUjVvnDvaOM30BP0AGW6yHhsGMpWgYzFiKxq1zB3vHmb6AHyCDLdZDw2DGUjQMZixF49a5g73jTF/AD5DBFuuhYTBjKRoGM5aicevcwd5xpi/gB7BPQCODLdZDw5wEthjMGMzMpqqM7x3QMCeBLdZDw5wEthjMGMzMpqqM7x3QMCeBLdZDw5wEthjMGMzMpqqM7x3QMCeBLdZDw5wEthjMGMzMpqqM7x3QMCeBLdZDw5wEthjMGMzMpqqM7x3QMCeBLdZDw5wEthjMGMzMpqqM7x3QuHVOmLmFvQYz7+DSLewtM753QOPWOWHmFvYazLyDS7ewt8z43gGNW+eEmVvYazDzDi7dwt4y43sHNG6dE2ZuYa/BzDu4dAt7y4zvHdC4dU6YuYW9BjPv4NIt7C0zvndA49Y5YeYW9hrMvINLt7C3zPheADO3sDdrZiZLJbA3a2bGYMZSNMqM7wUwcwt7s2ZmslQCe7NmZgxmLEWjzPheADO3sDdrZiZLJbA3a2bGYMZSNMqM7wUwcwt7s2ZmslQCe7NmZgxmLEWjzPheADO3sDdrZiZLJbA3a2bGYMZSNMqM7wUwcwt7s2ZmslQCe7NmZgxmLEWjzPTet8HPb/8AGhlsMZixFA1zTpjJUg+Z3vs2+PntH0Ajgy0GM5aiYc4JM1nqIdN73wY/v/0DaGSwxWDGUjTMOWEmSz1keu/b4Oe3fwCNDLYYzFiKhjknzGSph0zvfRv8/PYPoJHBFoMZS9Ew54SZLPWQ6b1vg5/f/gE0MthiMGMpGuacMJOlHjK+91F4TQZbrIfGO7hkMJOlqkxfwA8wC6/JYIv10HgHlwxmslSV6Qv4AWbhNRlssR4a7+CSwUyWqjJ9AT/ALLwmgy3WQ+MdXDKYyVJVpi/gB5iF12SwxXpovINLBjNZqsr0BfwAs/CaDLZYD413cMlgJktVmb6AH6D5Cbh0u8WWW9h728yWrIeZMuN7BzTewaXbLbbcwt7bZrZkPcyUGd87oPEOLt1useUW9t42syXrYabM+N4BjXdw6XaLLbew97aZLVkPM2XG9w5ovINLt1tsuYW9t81syXqYKTO+d0DjHVy63WLLLey9bWZL1sNMmfG9AxrmJLDFemiYc8LM30zRKDO+d0DDnAS2WA8Nc06Y+ZspGmXG9w5omJPAFuuhYc4JM38zRaPM+N4BDXMS2GI9NMw5YeZvpmiUGd87oGFOAlush4Y5J8z8zRSNMuN7BzTMSWCL9dAw54SZv5miUWZ874CGOQlssR4a5ryCSxlsyWDLFzB9Ez+JfRQaGWyxHhrmvIJLGWzJYMsXMH0TP4l9FBoZbLEeGua8gksZbMlgyxcwfRM/iX0UGhlssR4a5ryCSxlsyWDLFzB9Ez+JfRQaGWyxHhrmvIJLGWzJYMsXMH0TP4l9FBoZbLEeGua8gksZbMlgyxcwfRM/iX0UGhlssR4aGWz5vp4EtpQZ3zugYU4CW6yHRgZbvq8ngS1lxvcOaJiTwBbroZHBlu/rSWBLmfG9AxrmJLDFemhksOX7ehLYUmZ874CGOQlssR4aGWz5vp4EtpQZ3zugYU4CW6yHRgZbvq8ngS1lxvcOaLyDS7ZFw2Amgy0GM5ai8c6pMr53QOMdXLItGgYzGWwxmLEUjXdOlfG9Axrv4JJt0TCYyWCLwYylaLxzqozvHdB4B5dsi4bBTAZbDGYsReOdU2V874DGO7hkWzQMZjLYYjBjKRrvnCrjewc03sEl26JhMJPBFoMZS9F451QZ3/sovMbuoWHOCTPv4FIGW8aZvoAfYBZeY/fQMOeEmXdwKYMt40xfwA8wC6+xe2iYc8LMO7iUwZZxpi/gB5iF19g9NMw5YeYdXMpgyzjTF/ADzMJr7B4a5pww8w4uZbBlnOkL+AFm4TV2Dw1zTph5B5cy2DLO5y9Y/i/Zh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVTYh7VU2Ie1VNiHtVT4H95l1FLTauXpAAAAAElFTkSuQmCC"
}


This table describes the objects contained in the response example:



























Response ObjectObject Description
order_id
integer		Order identifier.
store_id
integer		Internal identifier that Rappi grants the store.
product_confirmation_code
string		Confirmation code associated with a specific order.
qr_code
string		QR code.


POST stores/{storeId}/orders/{orderId}/bag-drink-confirmation


Use this endpoint to confirm the number of bags and if there are drinks outside the bags in the order.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/bag-drink-confirmation


{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.


{storeId}: This is the identifier of the store.


{orderId}: This is the identifier of the order.



Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


This table describes the attributes that the JSON body of your call requires:






















AttributeRequiredDescription
number_of_bags
integer		requiredNumber of bags in the order.
has_drinks_outside_bag
boolean		requiredtrue if the order has drinks outside the bags, otherwise false.


Status Codes


These are the possible status codes of the response for this endpoint:






Sample Request


This is an example of an API request using this endpoint:


POST https://api.dev.rappi.com/restaurants/orders/v1/stores/392625/orders/203654/bag-drink-confirmation




This is an example of the request:




This is an example of the content of the body of the request:


{
  "number_of_bags": 2,
  "has_drinks_outside_bag": true
}


final Integer storeId = 392625;
final Integer orderId = 203654;

URL url = new URL(String.format("https://api.dev.rappi.com/restaurants/orders/v1/stores/%s/orders/%s/bag-drink-confirmation", storeId, orderId));

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");
connection.setDoOutput(true);

OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
writer.write("{\n  \"number_of_bags\": 2,\n  \"has_drinks_outside_bag\": true\n}");
writer.flush();
writer.close();
httpConn.getOutputStream().close();

System.out.println("Response Code : " + connection.getResponseCode());








Sample Response




This is an example of the response:




{
  "order_id": 2150145441,
  "store_id": 900103110,
  "number_of_bags": 2,
  "has_drinks_outside_bag": true,
  "last_updated_by": "store"
}


This table describes the objects contained in the response example:































Response ObjectObject Description
order_id
integer		Internal identifier assigned by Rappi to the store.
store_id
integer		Internal identifier assigned by Rappi to the store.
number_of_bags
integer		Number of bags.
has_drinks_outside_bag
boolean		true if the order has drinks outside the bags, otherwise false.
last_updated_by
string		Entity that made the confirmation, can be “store” for the store or “storekeeper” for the delivery person.


POST orders/{orderId}/ready-for-pickup


Use this endpoint to notify the courier in the Rappi application that the order is ready for pickup.
When the first request is made, if no courier is assigned, the system will speed up the assignment process; if a courier is already assigned, a notification will be sent to them, and the order status will change to READY_FOR_PICKUP. On the second request, if a courier is already assigned, a new notification will be sent to the assigned courier.


Endpoint URL


Use this URL to make a request with this endpoint:


https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/ready-for-pickup




Endpoint Properties


This resource has the following properties:



















Response formatsJSON
Authentication requirementsToken


Parameters


This endpoint does not permit additional parameters.


Important

To prevent misuse of the endpoint, we reserve the right to revoke access to clients who use it improperly. Therefore, after three requests, the system will stop executing additional actions, and any further attempts will be considered improper use of the endpoint.


Status Codes


These are the possible status codes of the response for this endpoint:






Sample Request


This is an example of an API request using this endpoint:


POST https://api.dev.rappi.com/restaurants/orders/v1/stores/9343463/orders/392625/ready-for-pickup




This is an example of the request:




final Integer orderId = 392625;
final Integer storeId = 9343463;

URL url = new URL(String.format("https://api.dev.rappi.com/restaurants/orders/v1/stores/%s/orders/%s/ready-for-pickup", storeId, orderId));

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "bearer YOUR_TOKEN");

System.out.println("Response Code : " + connection.getResponseCode());








Sample Response


This endpoint returns a status response code only.


PUT stores/{storeId}/orders/{orderId}/cancel_type/{cancelType}/reject


Use this endpoint to reject an order.


Endpoint URL


Use this URL to make a call with this endpoint:


https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/cancel_type/{cancelType}/reject


{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.


{storeId}: This is the store identifier.


{orderId}: This is the order identifier.


{cancelType}: This is the cancellation type identifier.



Endpoint Properties


This resource has the following properties:























Response formatJSON
Body requirements for callsJSON
Authentication requirementsToken


Response Codes


These are the possible response codes on this endpoint:





Call Example


This is an example of an API call using this endpoint:


PUT https://api.dev.rappi.com/restaurants/orders/v1/stores/392625/orders/203654/cancel_type/STORE_CLOSED/reject




This is an example of the call:




{
  "description": "ORDER RECEIVED OUTSIDE OF HOURS",
  "additional_info": {}
}






















AtributosRequeridoDescripción
description
string		requiredError message
additional_info
array of objects		requiredExtra information about the cancellation, its content depends on the type of cancellation.


Response Example


This endpoint only returns a status code for a successful result.