Referencia de API

La API de Rappi te permite administrar las órdenes que hacen los usuarios utilizando la aplicación de Rappi con los nuevos dominios. Las siguientes secciones describen el proceso para:

• Gestionar el flujo de trabajo y el estado de las órdenes de los usuarios.
• Obtener órdenes de usuarios a través de solicitudes al API.

Referencia de API

Utiliza el endpoint GET stores/{storeId}/orders para recuperar una lista de todas las órdenes de una tienda específica que están en estado READY para realizar más acciones.

Para recuperar nuevas órdenes:

Realiza una solicitud GET a la siguiente URL:

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

• {COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.
• {storeId}: Éste es el identificador de la tienda.

El sistema recupera una respuesta JSON con todos los nuevas órdenes de sus tiendas. Consulte la estructura de respuesta JSON en la sección de endpoint orders de la Referencia de API.

Cuando recupere la lista de sus nuevas órdenes, puede tomar las órdenes.

Referencia de API

Utiliza el endpoint PUT stores/{storeId}/orders/{orderId}/take para recibir órdenes que se encuentran en estado SENT.

Para aceptar una orden, haz una solicitud PUT a la siguiente URL:

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

• {COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.
• {storeId}: Este es el identificador de tu tienda.
• {orderId}: Este es el identificador de tu pedido.

Referencia de API

Utiliza el endpoint PUT stores/{storeId}/orders/{orderId}/cooking_time/{cookingTime}/take para recibir órdenes que se encuentran en estado SENT con un específico tiempo de cocción.

Para aceptar una orden, haz una solicitud PUT a la siguiente URL:

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

• {COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.
• {storeId}: Este es el identificador de tu tienda.
• {orderId}: Este es el identificador de tu pedido.
• {cookingTime}: Este es el tiempo de cocción nuevo.

Funcionalidad que permite modificar el tiempo de cocción de una orden al ser tomada y/o aceptada en el POS

¿Cuales son los tiempos de cocción?

La orden tiene tres posibles tiempos de coocción los cuales se aplican en el orden que se mencionan

• Tiempo de cocción predictivo
• Tiempo de cocción en CMS (con máximos y mínimos)
• Tiempo de cocción configurado en el core de la integración

¿Cómo funciona el tiempo de cocción?

El sistema hace un recorrido por cada uno de los tiempos de cocción en el orden mencionado para asignar el tiempo de cocción a la orden, y en caso que NO encuentre uno continúa con el siguiente hasta asignar el tiempo de cocción.

¿Se puede cambiar el tiempo de cocción?

Sí, Puede cambiar el tiempo de cocción por un valor contenido entre los valores del mínimo y máximo configurado en el core de la integración, y en caso que envie un valor que salga del rango configurado el sistema de manera automática toma el cambio en el mínimo o máximo configurado en el core de la integración.

Referencia de API

Utiliza el endpoint GET stores/{storeId}/orders/{orderId}/handoff para obtener el código de confirmación y código QR de la orden.

Para obtener el código QR de la orden, haz una solicitud GET a la siguiente URL:

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

• {COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.
• {storeId}: Este es el identificador de tu tienda.
• {orderId}: Este es el identificador de tu pedido.

El sistema recupera una respuesta JSON que contendrá el código, el QR, el order_id y el store_id de la orden. Consulte la estructura de respuesta JSON en la sección de endpoint orders de la Referencia de API.

Referencia de API

Utiliza el endpoint POST stores/{storeId}/orders/{orderId}/bag-drink-confirmation para confirmar el número de bolsas y si hay bebidas fuera de las bolsas de la orden.

Para realizar la confirmación del número de bolsas y si hay bebidas fuera de las bolsas de la orden, haz una solicitud POST a la siguiente URL:

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

• {COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.
• {storeId}: Este es el identificador de tu tienda.
• {orderId}: Este es el identificador de tu pedido.

El sistema recupera una respuesta JSON que contendrá el id de la orden, la entidad que realizó la confirmación (indicada en el campo last_updated_by, que puede ser "store" para la tienda o "storekeeper" para el repartidor), la cantidad de bolsas, la presencia de bebidas fuera de las bolsas, y las fechas de creación y última actualización. Consulte la estructura de respuesta JSON en la sección de endpoint orders de la Referencia de API.

Referencia de API

Si tus tiendas tienen configuraciones de notificación manual, use el endpoint POST stores/{storeId}/orders/{orderId}/ready-for-pickup para notificar a la aplicación de Rappi cuando una 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 hay un repartidor asignado, el sistema enviará una notificación al repartidor asignado.
• En función del estado actual de la orden, el sistema cambiará el estado de la orden a READY_FOR_PICKUP.

Al realizar la segunda solicitud:

• Si hay un repartidor asignado, el sistema enviará una notificación al repartidor asignado.

Para notificar a Rappi cuando una orden está lista para ser recogida, realiza una solicitud POST a la siguiente URL:

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

• {COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.
• {orderId}: Este es el identificador de tu pedido.

El sistema devuelve una respuesta JSON con el mensaje de confirmación "Order successfully updated".

Referencia de API

Utiliza el endpoint PUT stores/{storeId}/orders/{orderId}/cancel_type/{cancelType}/reject para rechazar la orden.

Para rechazar una orden, haz una solicitud PUT a la siguiente URL:

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

• {COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.
• {storeId}: Este es el identificador de tu tienda.
• {orderId}: Este es el identificador de tu pedido.
• {cancelType}: Corresponde al tipo de cancelación de tu pedido.

En la siguiente sección, se describen los tipos de cancelación que puedes utilizar para rechazar una orden.

Una cancelación por STORE_CLOSED se realiza cuando el restaurante está cerrado y no puede aceptar la orden.

{
  "description": "ORDEN RECEPCIONADA FUERA DE HORARIO",
  "additional_info": {}
}

Una cancelación por ITEM_STOCKOUT se realiza cuando el restaurante no tiene suficiente stock para completar la orden.

{
  "description": "Stock insuficiente en algunos artículos",
  "additional_info": {
    "items": ["sku-123", "sku-23"],
    "identity_type": "RAPPI/SKU"
  }
}

Una cancelación por POS_OFFLINE se realiza cuando el integrador recibe una orden y no puede conectarse al POS o Terminal.

{
  "description": "El restaurante tiene problemas y no puede recibir la orden",
  "additional_info": {}
}

Una cancelación por POS_INTERNAL_ERROR se realiza cuando existe un error interno en el POS o Terminal.

{
  "description": "Technical issue in server",
  "additional_info": {}
}

Una cancelación por INTEGRATOR_ERROR se realiza cuando el integrador no puede procesar la orden recibida por Rappi.

{
  "description": "Error al convertir la orden de Rappi",
  "additional_info": {}
}

Una cancelación por DELIVERY_METHOD_NOT_SUPPORTED se realiza cuando el integrador recibe una orden y no puede procesarla porque el método de entrega no es compatible.

{
  "description": "Método de entrega no soportado",
  "additional_info": {
    "received_value": "pickup",
    "available_options": ["delivery", "marketplace", "pickup"]
  }
}

Una cancelación por ORDER_TOTAL_INCORRECT se realiza cuando el total de la orden no coincide con la contabilidad en los sistemas del integrador.

{
  "description": "Totales incorrectos",
  "additional_info": {
    "received_value": 123.13,
    "expected_value": 130.23
  }
}

Una cancelación por ORDER_CHARGES_INCORRECT se realiza cuando hay un error en los cargos de la orden, como el service fee o delivery.

{
  "description": "El valor del delivery es incorrecto",
  "additional_info": {}
}

Una cancelación por ORDER_DISCOUNTS_INCORRECT se realiza cuando hay un error en los descuentos aplicados a la orden.

{
  "description": "El valor de uno o varios de los descuentos es incorrecto",
  "additional_info": {}
}

Una cancelación por OUTSIDE_DELIVERY_AREA se realiza cuando el integrador recibe una orden y requiere cancelarla porque el usuario se encuentra fuera del área de entrega.

{
  "description": "Fuera de área de entrega",
  "additional_info": {}
}

Una cancelación por ITEM_PRICE_INCORRECT se realiza cuando el integrador necesita validar los precios unitarios de cada producto y no coinciden con los precios en el POS.

{
  "description": "El precio de sku-23 está incorrecto",
  "additional_info": {
    "offending_items": [
      {
        "identifier": "sku-23",
        "identity_type": "RAPPI/SKU",
        "received_value": 123.13,
        "expected_value": 130.23
      }
    ]
  }
}

Una cancelación por ITEM_NOT_FOUND se realiza cuando el integrador recibe una orden y algunos de los identificadores de productos no son reconocidos por el POS.

{
  "description": "Los productos sku-123 y sku-23 no se encontraron en el sistema",
  "additional_info": {
    "items": ["sku-123", "sku-23"],
    "identity_type": "RAPPI/SKU"
  }
}

Una cancelación por CUSTOMER_INFO_INCORRECT se realiza cuando el integrador considera que hay problemas con la información del usuario.

{
  "description": "Información del cliente incorrecta",
  "additional_info": {}
}