Órdenes
Los recursos de órdenes te permiten interactuar con las órdenes de tus tiendas.
La siguiente tabla describe los diferentes contenidos del recurso órdenes:
GET orders
Usa este endpoint para obtener una lista con las nuevas órdenes para las tiendas del aliado autenticado.
URL del Endpoint
Usa esta URL para hacer una llamada con este endpoint:
https://{COUNTRY_DOMAIN}/restaurants/orders/v1/orders
{COUNTRY_DOMAIN}
: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.
Propiedades del Endpoint
Este recurso tienes las siguiente propiedades:
Formato de respuesta | JSON |
Requerimientos de autenticación | Token |
Códigos de Respuesta
Estos son los posibles códigos de respuesta en este endpoint:
Ejemplo de Llamada
Este es un ejemplo de una llamada API usando este endpoint:
GET https://api.dev.rappi.com/restaurants/orders/v1/orders
Este es un ejemplo de la llamada:
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());
Ejemplo de Respuesta
Este es un ejemplo de la respuesta:
[ { "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" } } ]
Esta tabla describe los objetos dentro de la respuesta de ejemplo:
Objeto en la respuesta | Descripción del objeto |
---|---|
order_detail array of objects | Propiedades de los detalles de la orden. |
order_detail.order_id string | Identificador de la orden. |
order_detail.develivey_operation_type string | Identificador para el tipo de orden: tipo turbo o tipo regular. |
order_detail.coooking_time integer | Tiempo de preparación estimado para la orden. |
order_detail.min_cooking_time integer | Tiempo mínimo de preparación en minutos para esta orden. |
order_detail.max_cooking_time integer | Tiempo máximo de preparación en minutos para esta orden. |
order_detail.created_at string | Fecha en la que se creó la orden. |
order_detail.delivery_method string, enumerable | Método de entrega de la orden. Opciones disponibles: delivery ,marketplace , pickup . |
order_detail.payment_method string, enumerable | Metodo de pago de la orden. Opciones disponibles: 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 . (Es importante tener en cuenta que Rappi constantemente acepta nuevos métodos de pago, por lo tanto esta lista puede variar en el tiempo y no es necesario validarla.) |
order_detail.delivery_information object | Propiedades de la dirección de entrega. |
order_detail.delivery_information.city string | Ciudad de la dirección de entrega |
order_detail.delivery_information.complete_address string | Dirección de entrega con todos los campos |
order_detail.delivery_information.street_number string | Numero de la calle |
order_detail.delivery_information.neighborhood string | Barrio de la dirección de entrega |
order_detail.delivery_information.complement string | Información adicional de la dirección de entrega |
order_detail.delivery_information.postal_code string | Código postal establecido para la dirección |
order_detail.delivery_information.street_name string | Nombre de la calle establecido para la dirección de entrega |
order_detail.billing_information array of objects | Propiedades de facturación del pago . |
order_detail.billing_information.address string | Dirección de entrega de la orden. |
order_detail.billing_information.billing_type string | Tipo de cobro de la orden. |
order_detail.billing_information.document_number string | Número de documento del cliente. |
order_detail.billing_information.document_type string | Tipo de documento del cliente. |
order_detail.billing_information.email string | Email establecido para recibir información de facturación. |
order_detail.billing_information.name string | Nombre establecido para la facturación. |
order_detail.billing_information.phone string | Teléfono establecido para la facturación. |
order_detail.totals array of objects | Propiedades del total de la orden. |
order_detail.totals.total_products integer | Total de los productos sin descuentos. |
order_detail.totals.total_discounts integer | Total de productos sin descuento en la orden. |
order_detail.totals.total_order integer | Cantidad total que el restaurante recibe. Cuando el metodo de entrega es marketplace este campo incluye propina y cargos de entrega.Para otros métodos de entrega, este campo contiene solo el valor total de todos los productos. En todos los casos, este campo incluye los descuentos asumidos por el restaurante. |
order_detail.totals.total_to_pay integer | El total que el usuario paga al repartidor en efectivo. Aplica únicamente cuando el metodo de entrega es marketplace o pickup , y el método de pago es: cash . |
order_detail.totals.discount_by_support integer | Descuento aplicado al usuario por el equipo de soporte de Rappi. |
order_detail.totals.charges array of objects | Propiedades de cargos adicionales de la orden . |
order_detail.totals.charges.shipping integer | Total de cargos de envío . |
order_detail.totals.charges.service_fee integer | Cargos del servicio de Rappi |
order_detail.totals.other_totals array of objects | Otros cargos incluidos en esta orden. |
order_detail.totals.other_totals.tip integer | Propina para el repartidor. |
order_detail.totals.other_totals.total_rappi_pay integer | Total pagado usando Rappi Pay. |
order_detail.totals.othet_totals.total_rappi_credits integer | Total pagado usando Rappi Creditos . |
order_detail.items array of objects | Propiedades de los artículos que contiene la orden. |
order_detail.items.sku string | SKU del artículo en el menú. El aliado asigna su propio SKU al artículo. |
order_detail.items.id string | Identificador del artículo en la orden. |
order_detail.items.name string | Nombre del artículo en la orden. |
order_detail.items.type string, enumerable | Tipo de artículo. Opciones disponibles: product , o topping . |
order_detail.items.comments array | Comentarios del usuario para un artículo en la orden. |
order_detail.items.price integer | Precio unitario del artículo sin descuento. |
order_detail.items.quantity integer | Cantidad especificada del artículo en la orden. |
order_detail.items.subitems array of objects | Propiedades de los subartículos en la orden. |
order_detail.items.subitems.sku string | SKU del subartículo en el menú. El aliado asigna su propio SKU al artículo. |
order_detail.items.subitems.id string | Identificador que Rappi asigna al artículo. |
order_detail.items.subitems.name string | Nombre del subartículo en la orden. |
order_detail.items.subitems.type string, enumerable | Tipo del subartículo en la orden. Opciones disponibles: product , o topping . |
order_detail.items.subitems.price integer | Precio unitario del subartículo sin descuento |
order_detail.items.subitems.quantity integer | Cantidad especificada del subartículo en la orden. |
order_detail.delivery_discount integer | Propiedades de los descuentos en la entrega de la orden. |
order_detail.delivery_discount.total_percentage_discount integer | Porcentaje de descuento en la entrega de la orden. |
order_detail.delivery_discount.total_value_discount integer | Monto total del descuento en la entrega. |
order_detail.customer array of objects | Propiedades del usuario de Rappi que crea la orden. Solo se envían cuando el método de entrega es marketplace o si se solicita a Rappi que envíe esta información |
order_detail.customer.first_name string | Nombre del usuario de Rappi que crea la orden. |
order_detail.customer.last_name string | Apellido del usuario de Rappi que crea la orden. |
order_detail.customer.phone_number string | Número de teléfono del usuario de Rappi que crea la orden. |
order_detail.customer.document_number string | Número de documento del usuario de Rappi que crea la orden. |
order_detail.customer.user_type string | Si el usuario es VIP se envía el valor USER_VIP . Para el resto de los usuarios este campo no se envía. |
order_detail.store array of objects | Propiedades de la tienda que prepara la orden. |
order_detail.store.internal_id string | Identificador interno que Rappi asigna a la tienda. |
order_detail.store.external_id string | Identificador de la integración que Rappi asigna a la tienda. |
order_detail.store.name string | Nombre de la tienda que prepara la orden. |
order_detail.discounts.value integer | Valor del descuento reflejado en divisa. |
order_detail.discounts.description string | Mensaje descriptivo explicando el descuento. |
order_detail.discounts.title string | Nombre del descuento. |
order_detail.discounts.product_id integer | ID del producto si el descuento aplica producto. |
order_detail.discounts.sku string | SKU del producto si el descuento aplica producto. |
order_detail.discounts.type string | Indica el tipo del descuento. |
order_detail.discounts.raw_value integer | El valor del descuento, puede representar un porcentaje o un valor en divisa dependiendo del type_value . |
order_detail.discounts.value_type string, enumerable | El tipo de valor del descuento. Opciones disponibles: value , percentage . |
order_detail.discounts.max_value integer | Máximo valor en divisa a descontar. |
order_detail.discounts.includes_toppings boolean | Indica si el descuento se resta del total de producto con toppings o no. |
order_detail.discounts.percentage_by_rappi integer | El porcentaje del descuento asumido por Rappi. |
order_detail.discounts.percentage_by_partners integer | El porcentaje del descuento asumido por el aliado. |
order_detail.discounts.amount_by_rappi integer | Valor del descuento reflejado en divisa asumido por Rappi. |
order_detail.discounts.amount_by_partner integer | Valor del descuento reflejado en divisa asumido por el aliado. |
order_detail.discounts.discount_product_units integer | Cantidad de productos a las que aplicó el descuento. |
order_detail.discounts.discount_product_unit_value integer | Valor del descuento por unidad de producto. |
GET stores/{storeId}/orders
Usa este endpoint para obtener una lista con las nuevas órdenes para la tienda específica del aliado autenticado.
URL del Endpoint
Usa esta URL para hacer una llamada con este endpoint:
https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders
{COUNTRY_DOMAIN}
: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.
{storeId}
: Este es el identificador de la tienda.
Propiedades del Endpoint
Este recurso tienes las siguiente propiedades:
Formato de respuesta | JSON |
Requerimientos de autenticación | Token |
Códigos de Respuesta
Estos son los posibles códigos de respuesta en este endpoint:
Ejemplo de Llamada
Este es un ejemplo de una llamada API usando este endpoint:
GET https://api.dev.rappi.com/restaurants/orders/v1/stores/205634/orders
Este es un ejemplo de la llamada:
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());
Ejemplo de Respuesta
Este es un ejemplo de la respuesta:
[ { "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" } } ]
Esta tabla describe los objetos dentro de la respuesta de ejemplo:
Objeto en la respuesta | Descripción del objeto |
---|---|
order_detail array of objects | Propiedades de los detalles de la orden. |
order_detail.order_id string | Identificador de la orden. |
order_detail.develivey_operation_type string | Identificador para el tipo de orden: tipo turbo o tipo regular. |
order_detail.coooking_time integer | Tiempo de preparación estimado para la orden. |
order_detail.min_cooking_time integer | Tiempo mínimo de preparación en minutos para esta orden. |
order_detail.max_cooking_time integer | Tiempo máximo de preparación en minutos para esta orden. |
order_detail.created_at string | Fecha en la que se creó la orden. |
order_detail.delivery_method string, enumerable | Método de entrega de la orden. Opciones disponibles: delivery ,marketplace , pickup . |
order_detail.payment_method string, enumerable | Metodo de pago de la orden. Opciones disponibles: 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 . (Es importante tener en cuenta que Rappi constantemente acepta nuevos métodos de pago, por lo tanto esta lista puede variar en el tiempo y no es necesario validarla.) |
order_detail.delivery_information object | Propiedades de la dirección de entrega. |
order_detail.delivery_information.city string | Ciudad de la dirección de entrega |
order_detail.delivery_information.complete_address string | Dirección de entrega con todos los campos |
order_detail.delivery_information.street_number string | Numero de la calle |
order_detail.delivery_information.neighborhood string | Barrio de la dirección de entrega |
order_detail.delivery_information.complement string | Información adicional de la dirección de entrega |
order_detail.delivery_information.postal_code string | Código postal establecido para la dirección |
order_detail.delivery_information.street_name string | Nombre de la calle establecido para la dirección de entrega |
order_detail.billing_information array of objects | Propiedades de facturación del pago . |
order_detail.billing_information.address string | Dirección de entrega de la orden. |
order_detail.billing_information.billing_type string | Tipo de cobro de la orden. |
order_detail.billing_information.document_number string | Número de documento del cliente. |
order_detail.billing_information.document_type string | Tipo de documento del cliente. |
order_detail.billing_information.email string | Email establecido para recibir información de facturación. |
order_detail.billing_information.name string | Nombre establecido para la facturación. |
order_detail.billing_information.phone string | Teléfono establecido para la facturación. |
order_detail.totals array of objects | Propiedades del total de la orden. |
order_detail.totals.total_products integer | Total de los productos sin descuentos. |
order_detail.totals.total_discounts integer | Total de productos sin descuento en la orden. |
order_detail.totals.total_order integer | Cantidad total que el restaurante recibe. Cuando el metodo de entrega es marketplace este campo incluye propina y cargos de entrega.Para otros métodos de entrega, este campo contiene solo el valor total de todos los productos. En todos los casos, este campo incluye los descuentos asumidos por el restaurante. |
order_detail.totals.total_to_pay integer | El total que el usuario paga al repartidor en efectivo. Aplica únicamente cuando el metodo de entrega es marketplace o pickup , y el método de pago es: cash . |
order_detail.totals.discount_by_support integer | Descuento aplicado al usuario por el equipo de soporte de Rappi. |
order_detail.totals.charges array of objects | Propiedades de cargos adicionales de la orden . |
order_detail.totals.charges.shipping integer | Total de cargos de envío . |
order_detail.totals.charges.service_fee integer | Cargos del servicio de Rappi |
order_detail.totals.other_totals array of objects | Otros cargos incluidos en esta orden. |
order_detail.totals.other_totals.tip integer | Propina para el repartidor. |
order_detail.totals.other_totals.total_rappi_pay integer | Total pagado usando Rappi Pay. |
order_detail.totals.othet_totals.total_rappi_credits integer | Total pagado usando Rappi Creditos . |
order_detail.items array of objects | Propiedades de los artículos que contiene la orden. |
order_detail.items.sku string | SKU del artículo en el menú. El aliado asigna su propio SKU al artículo. |
order_detail.items.id string | Identificador del artículo en la orden. |
order_detail.items.name string | Nombre del artículo en la orden. |
order_detail.items.type string, enumerable | Tipo de artículo. Opciones disponibles: product , o topping . |
order_detail.items.comments array | Comentarios del usuario para un artículo en la orden. |
order_detail.items.price integer | Precio unitario del artículo sin descuento. |
order_detail.items.quantity integer | Cantidad especificada del artículo en la orden. |
order_detail.items.subitems array of objects | Propiedades de los subartículos en la orden. |
order_detail.items.subitems.sku string | SKU del subartículo en el menú. El aliado asigna su propio SKU al artículo. |
order_detail.items.subitems.id string | Identificador que Rappi asigna al artículo. |
order_detail.items.subitems.name string | Nombre del subartículo en la orden. |
order_detail.items.subitems.type string, enumerable | Tipo del subartículo en la orden. Opciones disponibles: product , o topping . |
order_detail.items.subitems.price integer | Precio unitario del subartículo sin descuento |
order_detail.items.subitems.quantity integer | Cantidad especificada del subartículo en la orden. |
order_detail.delivery_discount integer | Propiedades de los descuentos en la entrega de la orden. |
order_detail.delivery_discount.total_percentage_discount integer | Porcentaje de descuento en la entrega de la orden. |
order_detail.delivery_discount.total_value_discount integer | Monto total del descuento en la entrega. |
order_detail.customer array of objects | Propiedades del usuario de Rappi que crea la orden. Solo se envían cuando el método de entrega es marketplace o si se solicita a Rappi que envíe esta información |
order_detail.customer.first_name string | Nombre del usuario de Rappi que crea la orden. |
order_detail.customer.last_name string | Apellido del usuario de Rappi que crea la orden. |
order_detail.customer.phone_number string | Número de teléfono del usuario de Rappi que crea la orden. |
order_detail.customer.document_number string | Número de documento del usuario de Rappi que crea la orden. |
order_detail.customer.user_type string | Si el usuario es VIP se envía el valor USER_VIP . Para el resto de los usuarios este campo no se envía. |
order_detail.store array of objects | Propiedades de la tienda que prepara la orden. |
order_detail.store.internal_id string | Identificador interno que Rappi asigna a la tienda. |
order_detail.store.external_id string | Identificador de la integración que Rappi asigna a la tienda. |
order_detail.store.name string | Nombre de la tienda que prepara la orden. |
order_detail.discounts.value integer | Valor del descuento reflejado en divisa. |
order_detail.discounts.description string | Mensaje descriptivo explicando el descuento. |
order_detail.discounts.title string | Nombre del descuento. |
order_detail.discounts.product_id integer | ID del producto si el descuento aplica producto. |
order_detail.discounts.sku string | SKU del producto si el descuento aplica producto. |
order_detail.discounts.type string | Indica el tipo del descuento. |
order_detail.discounts.raw_value integer | El valor del descuento, puede representar un porcentaje o un valor en divisa dependiendo del type_value . |
order_detail.discounts.value_type string, enumerable | El tipo de valor del descuento. Opciones disponibles: value , percentage . |
order_detail.discounts.max_value integer | Máximo valor en divisa a descontar. |
order_detail.discounts.includes_toppings boolean | Indica si el descuento se resta del total de producto con toppings o no. |
order_detail.discounts.percentage_by_rappi integer | El porcentaje del descuento asumido por Rappi. |
order_detail.discounts.percentage_by_partners integer | El porcentaje del descuento asumido por el aliado. |
order_detail.discounts.amount_by_rappi integer | Valor del descuento reflejado en divisa asumido por Rappi. |
order_detail.discounts.amount_by_partner integer | Valor del descuento reflejado en divisa asumido por el aliado. |
order_detail.discounts.discount_product_units integer | Cantidad de productos a las que aplicó el descuento. |
order_detail.discounts.discount_product_unit_value integer | Valor del descuento por unidad de producto. |
GET orders/status/sent
Usa este endpoint para obtener una lista con las nuevas órdenes en estado SENT
para las tiendas del aliado autenticado.
URL del Endpoint
Usa esta URL para hacer una llamada con este endpoint:
https://{COUNTRY_DOMAIN}/restaurants/orders/v1/orders/status/sent
{COUNTRY_DOMAIN}
: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.
Propiedades del Endpoint
Este recurso tienes las siguiente propiedades:
Formato de respuesta | JSON |
Requerimientos de autenticación | Token |
Códigos de Respuesta
Estos son los posibles códigos de respuesta en este endpoint:
Ejemplo de Llamada
Este es un ejemplo de una llamada API usando este endpoint:
GET https://api.dev.rappi.com/restaurants/orders/v1/orders/status/sent
Este es un ejemplo de la llamada:
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());
Ejemplo de Respuesta
Este es un ejemplo de la respuesta:
[ { "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" } } ]
Esta tabla describe los objetos dentro de la respuesta de ejemplo:
Objeto en la respuesta | Descripción del objeto |
---|---|
order_detail array of objects | Propiedades de los detalles de la orden. |
order_detail.order_id string | Identificador de la orden. |
order_detail.develivey_operation_type string | Identificador para el tipo de orden: tipo turbo o tipo regular. |
order_detail.coooking_time integer | Tiempo de preparación estimado para la orden. |
order_detail.min_cooking_time integer | Tiempo mínimo de preparación en minutos para esta orden. |
order_detail.max_cooking_time integer | Tiempo máximo de preparación en minutos para esta orden. |
order_detail.created_at string | Fecha en la que se creó la orden. |
order_detail.delivery_method string, enumerable | Método de entrega de la orden. Opciones disponibles: delivery ,marketplace , pickup . |
order_detail.payment_method string, enumerable | Metodo de pago de la orden. Opciones disponibles: 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 . (Es importante tener en cuenta que Rappi constantemente acepta nuevos métodos de pago, por lo tanto esta lista puede variar en el tiempo y no es necesario validarla.) |
order_detail.delivery_information object | Propiedades de la dirección de entrega. |
order_detail.delivery_information.city string | Ciudad de la dirección de entrega |
order_detail.delivery_information.complete_address string | Dirección de entrega con todos los campos |
order_detail.delivery_information.street_number string | Numero de la calle |
order_detail.delivery_information.neighborhood string | Barrio de la dirección de entrega |
order_detail.delivery_information.complement string | Información adicional de la dirección de entrega |
order_detail.delivery_information.postal_code string | Código postal establecido para la dirección |
order_detail.delivery_information.street_name string | Nombre de la calle establecido para la dirección de entrega |
order_detail.billing_information array of objects | Propiedades de facturación del pago . |
order_detail.billing_information.address string | Dirección de entrega de la orden. |
order_detail.billing_information.billing_type string | Tipo de cobro de la orden. |
order_detail.billing_information.document_number string | Número de documento del cliente. |
order_detail.billing_information.document_type string | Tipo de documento del cliente. |
order_detail.billing_information.email string | Email establecido para recibir información de facturación. |
order_detail.billing_information.name string | Nombre establecido para la facturación. |
order_detail.billing_information.phone string | Teléfono establecido para la facturación. |
order_detail.totals array of objects | Propiedades del total de la orden. |
order_detail.totals.total_products integer | Total de los productos sin descuentos. |
order_detail.totals.total_discounts integer | Total de productos sin descuento en la orden. |
order_detail.totals.total_order integer | Cantidad total que el restaurante recibe. Cuando el metodo de entrega es marketplace este campo incluye propina y cargos de entrega.Para otros métodos de entrega, este campo contiene solo el valor total de todos los productos. En todos los casos, este campo incluye los descuentos asumidos por el restaurante. |
order_detail.totals.total_to_pay integer | El total que el usuario paga al repartidor en efectivo. Aplica únicamente cuando el metodo de entrega es marketplace o pickup , y el método de pago es: cash . |
order_detail.totals.discount_by_support integer | Descuento aplicado al usuario por el equipo de soporte de Rappi. |
order_detail.totals.charges array of objects | Propiedades de cargos adicionales de la orden . |
order_detail.totals.charges.shipping integer | Total de cargos de envío . |
order_detail.totals.charges.service_fee integer | Cargos del servicio de Rappi |
order_detail.totals.other_totals array of objects | Otros cargos incluidos en esta orden. |
order_detail.totals.other_totals.tip integer | Propina para el repartidor. |
order_detail.totals.other_totals.total_rappi_pay integer | Total pagado usando Rappi Pay. |
order_detail.totals.othet_totals.total_rappi_credits integer | Total pagado usando Rappi Creditos . |
order_detail.items array of objects | Propiedades de los artículos que contiene la orden. |
order_detail.items.sku string | SKU del artículo en el menú. El aliado asigna su propio SKU al artículo. |
order_detail.items.id string | Identificador del artículo en la orden. |
order_detail.items.name string | Nombre del artículo en la orden. |
order_detail.items.type string, enumerable | Tipo de artículo. Opciones disponibles: product , o topping . |
order_detail.items.comments array | Comentarios del usuario para un artículo en la orden. |
order_detail.items.price integer | Precio unitario del artículo sin descuento. |
order_detail.items.quantity integer | Cantidad especificada del artículo en la orden. |
order_detail.items.subitems array of objects | Propiedades de los subartículos en la orden. |
order_detail.items.subitems.sku string | SKU del subartículo en el menú. El aliado asigna su propio SKU al artículo. |
order_detail.items.subitems.id string | Identificador que Rappi asigna al artículo. |
order_detail.items.subitems.name string | Nombre del subartículo en la orden. |
order_detail.items.subitems.type string, enumerable | Tipo del subartículo en la orden. Opciones disponibles: product , o topping . |
order_detail.items.subitems.price integer | Precio unitario del subartículo sin descuento |
order_detail.items.subitems.quantity integer | Cantidad especificada del subartículo en la orden. |
order_detail.delivery_discount integer | Propiedades de los descuentos en la entrega de la orden. |
order_detail.delivery_discount.total_percentage_discount integer | Porcentaje de descuento en la entrega de la orden. |
order_detail.delivery_discount.total_value_discount integer | Monto total del descuento en la entrega. |
order_detail.customer array of objects | Propiedades del usuario de Rappi que crea la orden. Solo se envían cuando el método de entrega es marketplace o si se solicita a Rappi que envíe esta información |
order_detail.customer.first_name string | Nombre del usuario de Rappi que crea la orden. |
order_detail.customer.last_name string | Apellido del usuario de Rappi que crea la orden. |
order_detail.customer.phone_number string | Número de teléfono del usuario de Rappi que crea la orden. |
order_detail.customer.document_number string | Número de documento del usuario de Rappi que crea la orden. |
order_detail.customer.user_type string | Si el usuario es VIP se envía el valor USER_VIP . Para el resto de los usuarios este campo no se envía. |
order_detail.store array of objects | Propiedades de la tienda que prepara la orden. |
order_detail.store.internal_id string | Identificador interno que Rappi asigna a la tienda. |
order_detail.store.external_id string | Identificador de la integración que Rappi asigna a la tienda. |
order_detail.store.name string | Nombre de la tienda que prepara la orden. |
order_detail.discounts.value integer | Valor del descuento reflejado en divisa. |
order_detail.discounts.description string | Mensaje descriptivo explicando el descuento. |
order_detail.discounts.title string | Nombre del descuento. |
order_detail.discounts.product_id integer | ID del producto si el descuento aplica producto. |
order_detail.discounts.sku string | SKU del producto si el descuento aplica producto. |
order_detail.discounts.type string | Indica el tipo del descuento. |
order_detail.discounts.raw_value integer | El valor del descuento, puede representar un porcentaje o un valor en divisa dependiendo del type_value . |
order_detail.discounts.value_type string, enumerable | El tipo de valor del descuento. Opciones disponibles: value , percentage . |
order_detail.discounts.max_value integer | Máximo valor en divisa a descontar. |
order_detail.discounts.includes_toppings boolean | Indica si el descuento se resta del total de producto con toppings o no. |
order_detail.discounts.percentage_by_rappi integer | El porcentaje del descuento asumido por Rappi. |
order_detail.discounts.percentage_by_partners integer | El porcentaje del descuento asumido por el aliado. |
order_detail.discounts.amount_by_rappi integer | Valor del descuento reflejado en divisa asumido por Rappi. |
order_detail.discounts.amount_by_partner integer | Valor del descuento reflejado en divisa asumido por el aliado. |
order_detail.discounts.discount_product_units integer | Cantidad de productos a las que aplicó el descuento. |
order_detail.discounts.discount_product_unit_value integer | Valor del descuento por unidad de producto. |
PUT stores/{storeId}/orders/{orderId}/take
Usa este endpoint para tomar una orden para que la tienda comience a prepararla.
URL del Endpoint
Usa esta URL para hacer una llamada con este endpoint:
https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/take
{COUNTRY_DOMAIN}
: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.
{storeId}
: Este es el identificador de la tienda.
{orderId}
: Este es el identificador de la orden.
Propiedades del Endpoint
Este recurso tienes las siguiente propiedades:
Formato de respuesta | JSON |
Requerimientos de autenticación | Token |
Códigos de Respuesta
Estos son los posibles códigos de respuesta en este endpoint:
Ejemplo de Llamada
Este es un ejemplo de una llamada API usando este endpoint:
PUT https://api.dev.rappi.com/restaurants/orders/v1/stores/392625/orders/203654/take
Este es un ejemplo de la llamada:
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());
Ejemplo de Respuesta
Este endpoint únicamente regresa un código de estado.
PUT stores/{storeId}/orders/{orderId}/cooking_time/{cookingTime}/take
Usa este endpoint para tomar una orden para que la tienda comience a prepararla.
URL del Endpoint
Usa esta URL para hacer una llamada con este endpoint:
https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/cooking_time/{cookingTime}/take
{COUNTRY_DOMAIN}
: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.
{storeId}
: Este es el identificador de la tienda.
{orderId}
: Este es el identificador de la orden.
{cookingTime}
: Este es el nuevo tiempo de cocción de la orden.
Propiedades del Endpoint
Este recurso tienes las siguiente propiedades:
Formato de respuesta | JSON |
Requerimientos de autenticación | Token |
Códigos de Respuesta
Estos son los posibles códigos de respuesta en este endpoint:
Ejemplo de Llamada
Este es un ejemplo de una llamada API usando este endpoint:
PUT https://api.dev.rappi.com/restaurants/orders/v1/stores/205643/orders/392625/cooking_time/20/take
Este es un ejemplo de la llamada:
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());
Ejemplo de Respuesta
Este endpoint únicamente regresa un código de estado.
GET stores/{storeId}/orders/{orderId}/handoff
Usa este endpoint para tomar una orden para que la tienda comience a prepararla.
URL del Endpoint
Usa esta URL para hacer una llamada con este endpoint:
https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/handoff
{COUNTRY_DOMAIN}
: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.
{storeId}
: Este es el identificador de la tienda.
{orderId}
: Este es el identificador de la orden.
Propiedades del Endpoint
Este recurso tienes las siguiente propiedades:
Formato de respuesta | JSON |
Requerimientos de autenticación | Token |
Códigos de Respuesta
Estos son los posibles códigos de respuesta en este endpoint:
Ejemplo de Llamada
Este es un ejemplo de una llamada API usando este endpoint:
GET https://api.dev.rappi.com/restaurants/orders/v1/stores/392625/orders/203654/handoff
Este es un ejemplo de la llamada:
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());
Ejemplo de Respuesta
Este es un ejemplo de la respuesta:
{ "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" }
Esta tabla describe los objetos dentro de la respuesta de ejemplo:
Objeto en la respuesta | Descripción del objeto |
---|---|
order_id integer | Identificador de la orden. |
store_id integer | Identificador interno que Rappi asigna a la tienda. |
product_confirmation_code string | Código de confirmación asociado a un pedido específico. |
qr_code string | Código QR. |
POST stores/{storeId}/orders/{orderId}/bag-drink-confirmation
Usa este endpoint para confirmar el número de bolsas y si hay bebidas fuera de las bolsas de la orden.
URL del Endpoint
Usa esta URL para hacer una llamada con este endpoint:
https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/bag-drink-confirmation
{COUNTRY_DOMAIN}
: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.
{storeId}
: Este es el identificador de la tienda.
{orderId}
: Este es el identificador de la orden.
Propiedades del Endpoint
Este recurso tienes las siguiente propiedades:
Formato de respuesta | JSON |
Requerimientos de autenticación | Token |
Esta tabla describe los atributos que el JSON
de el body de tu llamada requiere:
Atributos | Requerido | Descripción |
---|---|---|
number_of_bags integer | requerido | Número de bolsas que tiene la orden. |
has_drinks_outside_bag boolean | requerido | true si la orden tiene bebidas fuera de las bolsas, de lo contrario false . |
Códigos de Respuesta
Estos son los posibles códigos de respuesta en este endpoint:
Ejemplo de Llamada
Este es un ejemplo de una llamada API usando este endpoint:
POST https://api.dev.rappi.com/restaurants/orders/v1/stores/392625/orders/203654/bag-drink-confirmation
Este es un ejemplo de la llamada:
Este es un ejemplo de contenido del body de la llamada:
{ "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());
Ejemplo de Respuesta
Este es un ejemplo de la respuesta:
{ "order_id": 2150145441, "store_id": 900103110, "number_of_bags": 2, "has_drinks_outside_bag": true, "last_updated_by": "store" }
Esta tabla describe los objetos dentro de la respuesta de ejemplo:
Objeto en la respuesta | Descripción del objeto |
---|---|
order_id integer | Identificador interno que Rappi asigna a la tienda. |
store_id integer | Identificador interno que Rappi asigna a la tienda. |
number_of_bags integer | Número de bolsas. |
has_drinks_outside_bag boolean | true si la orden tiene bebidas fuera de las bolsas, de lo contrario false . |
last_updated_by string | Entidad que realizó la confirmación, puede ser "store" para la tienda o "storekeeper" para el repartidor. |
POST orders/{orderId}/ready-for-pickup
Usa este endpoint para notificar al repartidor en la app de Rappi que su orden está lista para ser recogida.
Al realizar la primera solicitud, si no hay un repartidor asignado, el sistema acelerará el proceso de asignación; si ya hay un repartidor asignado, se le enviará una notificación y el estado de la orden cambiará a READY_FOR_PICKUP
. En la segunda solicitud, si el repartidor ya está asignado, se enviará una nueva notificación al repartidor asignado.
URL del Endpoint
Usa esta URL para hacer llamadas con este endpoint:
https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/ready-for-pickup
{COUNTRY_DOMAIN}
: Este es tu Dominio por País de Rappi. Mira la lista de dominios por país.{orderId}
: Este es el identificador de la orden.
Propiedades del Endpoint
Este recurso tiene las siguientes propiedades:
Formato de respuesta | JSON |
Requerimientos de autenticación | Token |
Parámetros
Este endpoint no permite parámetros adicionales.
Important
Para evitar el uso indebido del endpoint, nos reservamos el derecho de revocar el acceso a aquellos clientes que lo utilicen de manera inapropiada. Es por ello que después de tres solicitudes, el sistema dejará de ejecutar acciones adicionales, por lo que cualquier intento posterior será considerado un uso incorrecto del endpoint.
Códigos de Respuesta
Estos son los posibles códigos de respuesta en este endpoint:
Ejemplo de Llamada
Este es un ejemplo de una llamada API usando este endpoint:
POST https://api.dev.rappi.com/restaurants/orders/v1/stores/9343463/orders/392625/ready-for-pickup
Este es un ejemplo de la llamada:
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());
Ejemplo de Respuesta
Este endpoint regresa unicamente un código de respuesta.
PUT stores/{storeId}/orders/{orderId}/cancel_type/{cancelType}/reject
Usa este endpoint para rechazar una orden.
URL del Endpoint
Usa esta URL para hacer una llamada con este endpoint:
https://{COUNTRY_DOMAIN}/restaurants/orders/v1/stores/{storeId}/orders/{orderId}/cancel_type/{cancelType}/reject
{COUNTRY_DOMAIN}
: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.
{storeId}
: Este es el identificador de la tienda.
{orderId}
: Este es el identificador de la orden.
{cancelType}
: Este es el identificador del tipo de cancelación.
Propiedades del Endpoint
Este recurso tiene las siguientes propiedades:
Formato de respuesta | JSON |
Requerimientos del body para llamadas | JSON |
Requerimientos de autenticación | Token |
Códigos de Respuesta
Estos son los posibles códigos de respuesta en este endpoint:
Ejemplo de Llamada
Este es un ejemplo de una llamada API usando este endpoint:
PUT https://api.dev.rappi.com/restaurants/orders/v1/stores/392625/orders/203654/cancel_type/STORE_CLOSED/reject
{ "description": "ORDEN RECEPCIONADA FUERA DE HORARIO", "additional_info": {} }
Atributos | Requerido | Descripción |
---|---|---|
description string | requerido | Mensaje del error |
additional_info array of objects | requerido | Información extra sobre la cancelación, su contenido depende del tipo de cancelación. |
Ejemplo de Respuesta
Este endpoint únicamente regresa un código de estado para un resultado exitoso.