Gestionar Disponibilidad#

Referencia de API

La API de Rappi te permite configurar la disponibilidad de los elementos de tus menús y tus tiendas, utilizando el recurso items.

Las siguientes secciones te guían a través del proceso de configuración de estas opciones para tu integración.

Disponibilidad del Artículo#

Configura la disponibilidad de los elementos de tu menú y desactívalos cuando estén agotados, para evitar pedidos entrantes que contengan productos no disponibles.

La API de Rappi te permite configurar la disponibilidad mediante:

  • Item SKU: Este es el SKU que proporcionaste para el artículo a Rappi cuando lo agregaste al menú.
  • Item ID: Este es el identificador que Rappi le proporcionó al agregarlo al menú.

Configuración de la Disponibilidad por SKU#

Referencia de API

Utiliza el endpoint PUT availability/stores/items para configurar la disponibilidad de tus artículos por SKU de artículo.

Para configurar la disponibilidad de tus artículos por SKU de artículo:

Realiza una solicitud PUT a la siguiente URL y agrega unJSON al cuerpo de la solicitud con los siguientes objetos.

URL: https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/token

{COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.

Este es un ejemplo del JSON en el cuerpo de la solicitud:

[
   {
      "store_integration_id":"999",
      "items":{
         "turn_on":[
            "1111",
            "2222",
            "3333"
         ],
         "turn_off":[
            "5555"
         ]
      }
   }
]

Note

Los valores de este objeto JSON no son datos reales. Asegúrate de reemplazarlos con tus propios datos cuando realices solicitudes de API. Puedes agregar más elementos a los objetos turn_on yturn_off en el JSON separados por una coma. Si solo deseas activar o desactivar elementos en su solicitud, elimina el otro objeto de tu JSON en consecuencia.

El sistema regresa una respuesta JSON con el mensaje de confirmación Items successfully updated.

Configuración de la Disponibilidad por ID de Rappi#

Referencia de API

Utiliza el endpoint PUT availability/stores/items/rappi para configurar la disponibilidad de sus artículos por ID de artículo.

Para configurar la disponibilidad de tus artículos por ID de artículo:

Realiza una solicitud PUT a la siguiente URL y agrega unJSON al cuerpo de la solicitud con los siguientes objetos.

URL: https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores/items/rappi

{COUNTRY_DOMAIN}: Este es su dominio de país de Rappi. Ver la lista de dominios de países.

Este es un ejemplo del JSON en el cuerpo de la solicitud:

[
   {
      "store_integration_id":"999",
      "items":{
         "turn_on":[
            1111,
            2222,
            3333
         ],
         "turn_off":[
            5555
         ]
      }
   }
]

Note

Los valores de este JSON no son datos reales. Asegúrate de reemplazarlos con tus datos cuando realices solicitudes de API. Puedes agregar más elementos a los objetos turn_on y turn_off en el JSON separados por una coma. Si solo deseaS activar o desactivar elementos en tu solicitud, elimina el otro objeto de tu JSON en consecuencia.

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

Disponibilidad de la tienda (asincrono)#

Referencia de API

Utiliza el endpoint PUT availability/stores para configurar la disponibilidad de tus tiendas.

Importante

Este es un método asincrono por lo tanto el resultado de la operación no vendrá en la respuesta. Usando este enfoque se puede recibir el nuevo estado de la tienda a través del webhoook STORE_CONNECTIVITY. Ver Store Connectivity

Si se necesita una respuesta instantanea se debe usar el endpoint sincrono. Ver Disponibilidad de la tienda (sincrono)

Para configurar la disponibilidad de tus tiendas:

Realiza una solicitud PUT a la siguiente URL y agrega un JSON al cuerpo de la solicitud con los siguientes objetos.

URL: https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores

{COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.

Este es un ejemplo del JSON en el cuerpo de la solicitud:

{
   "turn_on":[
      "2222"
   ],
   "turn_off":[
      "333",
      "444"
   ]
}

Notes

  • Los valores de este JSON no son datos reales. Asegúrate de reemplazarlos con tus datos cuando realices solicitudes de API.
  • Puedes agregar más elementos a los objetos turn_on yturn_off en el JSON separados por una coma.
  • Si solo deseas activar o desactivar elementos en tu solicitud, elimina el otro objeto de tu JSON en consecuencia.

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

Disponibilidad de la tienda masivo (asincrono)#

Referencia de API

Utiliza el endpoint PUT availability/stores/enable/massive para configurar la disponibilidad de tus tiendas.

Importante

Este es un método asincrono por lo tanto el resultado de la operación no vendrá en la respuesta. Usando este enfoque se puede recibir el nuevo estado de la tienda a través del webhoook STORE_CONNECTIVITY. Ver Store Connectivity

Es posible que una tienda no pueda ser encendida o apagada debido a que está suspendida o no publicada en la app de Rappi

Para configurar la disponibilidad de tus tiendas:

Realiza una solicitud PUT a la siguiente URL y agrega un JSON al cuerpo de la solicitud con los siguientes objetos.

URL: https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores/enable/massive

{COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.

Este es un ejemplo del JSON en el cuerpo de la solicitud:

{
    "stores": [
        {
            "store_id": "12312",
            "is_enabled": true
        },
        {
            "store_id": "12312",
            "is_enabled": false
        }
    ]
}

Disponibilidad de la tienda (sincrono)#

Referencia de API

Utiliza el endpoint PUT availability/stores/enable para configurar la disponibilidad de tus tiendas.

Importante

Este es un método sincrono por lo tanto el resultado de la operación vendrá directamente en la respuesta

Tenga en cuenta que se permite un máximo de 300 tiendas por request. Si necesita enviar mas stores utilice el metodo asincrono. Ver Disponibilidad de la tienday (asincrono)

Es posible que una tienda no pueda ser encendida o apagada debido a que está suspendida o no publicada en la app de Rappi

Para configurar la disponibilidad de tus tiendas:

Realiza una solicitud PUT a la siguiente URL y agrega un JSON al cuerpo de la solicitud con los siguientes objetos.

URL: https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/availability/stores/enable

{COUNTRY_DOMAIN}: Este es tu dominio de país de Rappi. Ver la lista de dominios de países.

Este es un ejemplo del JSON en el cuerpo de la solicitud:

{
    "stores": [
        {
            "store_id": "12312",
            "is_enabled": true
        },
        {
            "store_id": "12312",
            "is_enabled": false
        }
    ]
}

Este es un ejemplo del JSON de respuesta:

{
    "results":[
        {
            "store_id": 90774,
            "is_enabled": false,
            "operation_result": false,
            "operation_result_type": "suspended",
            "suspended_reason": "suspended due to cancelled orders",
            "suspended_at": "2022-04-11T20:23:00.00Z",
            "suspended_time": 60
        }
    ]
}