Developer Portal | Rappi - NEW Rests API de Menu

El recurso Menús permite interactuar con los menús y productos de un restaurante.

La siguiente tabla describe los diferentes contenidos del recurso Menú:

Resource	Description
`PATCH /restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock`	Gestiona de forma asincrónica la disponibilidad de productos por SKU o ID en la app de Rappi
`POST /restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock/status`	Devuelve la disponibilidad de productos por SKU o ID en la app de Rappi
`PATCH /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock`	Gestiona de forma asincrónica la disponibilidad de toppings por SKU o ID en la app de Rappi
`POST /restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock/status`	Devuelve la disponibilidad de toppings por SKU o ID en la app de Rappi
`PATCH /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock`	Gestiona de forma asincrónica la disponibilidad de productos y toppings por SKU o ID en la app de Rappi
`POST /restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock/status`	Devuelve la disponibilidad de productos y toppings por SKU o ID en la app de Rappi

PATCH Disponibilidad de productos por SKU o ID

Utilice este endpoint para habilitar o deshabilitar productos en masa para una tienda específica.

Endpoint URL

Utilice esta URL para realizar una solicitud a este endpoint:

URL: https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock

{NEW_DOMAIN}: Este es tu dominio de país de Rappi. Consulta la lista de dominios de país. Consulta la lista de dominios de país.

Propiedades del Endpoint (Encabezados)

Este recurso tiene las siguientes propiedades:

Header	Value
`Content-Type`	application/json
`x-authorization`	access_token

Parametros

Parameter	Description
`storeId`	Este es el identificador de la tienda en el lado de Rappi.
`identityType`	Los valores posibles son `RAPPI, SKU`; donde debe utilizar `RAPPI` si los identificadores utilizados para la activación/desactivación son ID de Rappi, y `SKU` si se utilizan identificadores de comerciante.

Ejemplo de solicitud

Este es un ejemplo de una solicitud de API que utiliza este endpoint:

PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock

Este es un ejemplo de la solicitud:

{
  "available": ["123123"],
  "unavailable": []
}

Esta tabla describe los atributos que requiere el JSON de su solicitud:

Attributes		Required	Description
`available`	array of strings	`true`	Listado de identificadores de productos, ya sean SKUs o Rappi IDs, a habilitar.
`unavailable`	array of strings	`true`	Listado de identificadores de productos, ya sean SKUs o Rappi IDs, que se deshabilitarán .


URL url = new URL("https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/products/RAPPI/stock");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod("PATCH");

httpConn.setRequestProperty("x-authorization", "Bearer <access_token>");
httpConn.setRequestProperty("Content-Type", "application/json");

httpConn.setDoOutput(true);
OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
writer.write("{\n    \"available\": [\n        \"123123\"\n    ],\n    \"unavailable\": [\n    ]\n}");
writer.flush();
writer.close();
httpConn.getOutputStream().close();

InputStream responseStream = httpConn.getResponseCode() / 100 == 2
        ? httpConn.getInputStream()
        : httpConn.getErrorStream();
Scanner s = new Scanner(responseStream).useDelimiter("\\A");
String response = s.hasNext() ? s.next() : "";
System.out.println(response);

Códigos de respuesta

Estos son los posibles códigos de respuesta para este endpoint:

Ejemplo de respuesta

Ejemplo de respuesta exitosa:

{
  "message": "Your request has been accepted"
}

Esta tabla describe los objetos contenidos en el ejemplo de respuesta:

Response Object		Object Description
`message`	string	Muestra el mensaje de que la solicitud ha sido aceptada.

POST Validar disponibilidad de productos por SKU o ID

Utilice este endpoint para validar la disponibilidad de productos en masa para una tienda específica.

Endpoint URL

Utilice esta URL para realizar una solicitud con este endpoint:

URL: https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock/status

{NEW_DOMAIN}: Este es tu dominio de país de Rappi. Consulta la lista de dominios de país. Consulta la lista de dominios de país.

Propiedades del endpoint (Encabezados)

Este recurso tiene las siguientes propiedades:

Header	Value
`Content-Type`	application/json
`x-authorization`	access_token

Parametros

Parameter	Description
`storeId`	Este es el identificador de la tienda en el lado de Rappi.
`identityType`	Los valores posibles son `RAPPI, SKU`; donde debes utilizar `RAPPI` si los identificadores utilizados para la activación/desactivación son Rappi ID, y `SKU` si se utilizan identificadores de comerciante.

Solicitud de muestra

Este es un ejemplo de una solicitud de API que utiliza este endpoint:

POST https://api.dev.rappi.com/restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock/status

Este es un ejemplo de la solicitud:

{
  "products": ["123123"]
}

Esta tabla describe los atributos que requiere el JSON en el cuerpo de su solicitud:

Attributes		Required	Description
`products`	array of strings	`true`	Listado de identificadores de productos, ya sean SKUs o Rappi IDs, a habilitar.


URL url = new URL("https://api.dev.rappi.com/restaurants/menu/v1/stores/{storeId}/products/{identityType}/stock/status");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod("POST");

httpConn.setRequestProperty("x-authorization", "Bearer <access_token>");
httpConn.setRequestProperty("Content-Type", "application/json");

httpConn.setDoOutput(true);
OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
writer.write("{\n\"products\":[\n\"123123\"\n]\n}");
writer.flush();
writer.close();
httpConn.getOutputStream().close();

InputStream responseStream = httpConn.getResponseCode() / 100 == 2
        ? httpConn.getInputStream()
        : httpConn.getErrorStream();
Scanner s = new Scanner(responseStream).useDelimiter("\\A");
String response = s.hasNext() ? s.next() : "";
System.out.println(response);

Códigos de respuesta

Estos son los posibles códigos de respuesta para este endpoint:

Respuesta de muestra

Este es un ejemplo de respuesta:

Ejemplo de respuesta exitosa:

[
  {
    "item_id": 123456,
    "item_sku": "",
    "item_type": "PRODUCT",
    "stock_out_state": "UNKNOWN"
  }
]

Esta tabla describe los objetos contenidos en el ejemplo de respuesta:

Response Object		Object Description
`item_id`	long	ID del artículo Rappi
`item_sku`	string	Código del artículo.
`item_type`	string	El tipo de artículo puede ser `PRODUCT` `TOPPING` `ITEM`.
`stock_out_state`	string	Estado de stock del artículo.

PATCH Disponibilidad de toppings por SKU o ID

Utilice este endpoint para habilitar o deshabilitar toppings en masa para una tienda específica.

Endpoint URL

Utilice esta URL para realizar una solicitud a este endpoint:

URL: https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock

{NEW_DOMAIN}: Este es tu dominio de país de Rappi. Consulta la lista de dominios de país. Consulta la lista de dominios de país.

Propiedades del Endpoint (Encabezados)

Este recurso tiene las siguientes propiedades:

Header	Value
`Content-Type`	application/json
`x-authorization`	access_token

Parametros

Parameter	Description
`storeId`	Este es el identificador de la tienda en el lado de Rappi.
`identityType`	Los valores posibles son `RAPPI, SKU`; donde debe utilizar `RAPPI` si los identificadores utilizados para la activación/desactivación son ID de Rappi, y `SKU` si se utilizan identificadores de comerciante.

Ejemplo de solicitud

Este es un ejemplo de una solicitud de API que utiliza este endpoint:

PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock

Este es un ejemplo de la solicitud:

{
  "available": ["123123"],
  "unavailable": []
}

Esta tabla describe los atributos que requiere el JSON de su solicitud:

Attributes		Required	Description
`available`	array of strings	`true`	Listado de identificadores de toppings, ya sean SKUs o Rappi IDs, a habilitar.
`unavailable`	array of strings	`true`	Listado de identificadores de toppings, ya sean SKUs o Rappi IDs, que se deshabilitarán .


URL url = new URL("https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/toppings/RAPPI/stock");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod("PATCH");

httpConn.setRequestProperty("x-authorization", "Bearer <access_token>");
httpConn.setRequestProperty("Content-Type", "application/json");

httpConn.setDoOutput(true);
OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
writer.write("{\n    \"available\": [\n        \"123123\"\n    ],\n    \"unavailable\": [\n    ]\n}");
writer.flush();
writer.close();
httpConn.getOutputStream().close();

InputStream responseStream = httpConn.getResponseCode() / 100 == 2
        ? httpConn.getInputStream()
        : httpConn.getErrorStream();
Scanner s = new Scanner(responseStream).useDelimiter("\\A");
String response = s.hasNext() ? s.next() : "";
System.out.println(response);

Códigos de respuesta

Estos son los posibles códigos de respuesta para este endpoint:

Ejemplo de respuesta

Ejemplo de respuesta exitosa:

{
  "message": "Your request has been accepted"
}

Esta tabla describe los objetos contenidos en el ejemplo de respuesta:

Response Object		Object Description
`message`	string	Muestra el mensaje de que la solicitud ha sido aceptada.

POST Validar disponibilidad de toppings por SKU o ID

Utilice este endpoint para validar la disponibilidad de toppings en masa para una tienda específica.

Endpoint URL

Utilice esta URL para realizar una solicitud con este endpoint:

URL: https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock/status

{NEW_DOMAIN}: Este es tu dominio de país de Rappi. Consulta la lista de dominios de país. Consulta la lista de dominios de país.

Propiedades del endpoint (Encabezados)

Este recurso tiene las siguientes propiedades:

Header	Value
`Content-Type`	application/json
`x-authorization`	access_token

Parametros

Parameter	Description
`storeId`	Este es el identificador de la tienda en el lado de Rappi.
`identityType`	Los valores posibles son `RAPPI, SKU`; donde debes utilizar `RAPPI` si los identificadores utilizados para la activación/desactivación son Rappi ID, y `SKU` si se utilizan identificadores de comerciante.

Solicitud de muestra

Este es un ejemplo de una solicitud de API que utiliza este endpoint:

POST https://api.dev.rappi.com/restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock/status

Este es un ejemplo de la solicitud:

{
  "toppings": ["123123"]
}

Esta tabla describe los atributos que requiere el JSON en el cuerpo de su solicitud:

Attributes		Required	Description
`toppings`	array of strings	`true`	Listado de identificadores de toppings, ya sean SKUs o Rappi IDs, a habilitar.


URL url = new URL("https://api.dev.rappi.com/restaurants/menu/v1/stores/{storeId}/toppings/{identityType}/stock/status");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod("POST");

httpConn.setRequestProperty("x-authorization", "Bearer <access_token>");
httpConn.setRequestProperty("Content-Type", "application/json");

httpConn.setDoOutput(true);
OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
writer.write("{\n\"toppings\":[\n\"123123\"\n]\n}");
writer.flush();
writer.close();
httpConn.getOutputStream().close();

InputStream responseStream = httpConn.getResponseCode() / 100 == 2
        ? httpConn.getInputStream()
        : httpConn.getErrorStream();
Scanner s = new Scanner(responseStream).useDelimiter("\\A");
String response = s.hasNext() ? s.next() : "";
System.out.println(response);

Códigos de respuesta

Estos son los posibles códigos de respuesta para este endpoint:

Respuesta de muestra

Este es un ejemplo de respuesta:

Ejemplo de respuesta exitosa:

[
  {
    "item_id": 123456,
    "item_sku": "",
    "item_type": "TOPPING",
    "stock_out_state": "UNKNOWN"
  }
]

Esta tabla describe los objetos contenidos en el ejemplo de respuesta:

Response Object		Object Description
`item_id`	long	ID del artículo Rappi
`item_sku`	string	Código del artículo.
`item_type`	string	El tipo de artículo puede ser `PRODUCT` `TOPPING` `ITEM`.
`stock_out_state`	string	Estado de stock del artículo.

PATCH Disponibilidad de articulos por SKU o ID

Utilice este endpoint para habilitar o deshabilitar articulos en masa para una tienda específica.

Endpoint URL

Utilice esta URL para realizar una solicitud a este endpoint:

URL: https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock

{NEW_DOMAIN}: Este es tu dominio de país de Rappi. Consulta la lista de dominios de país. Consulta la lista de dominios de país.

Propiedades del Endpoint (Encabezados)

Este recurso tiene las siguientes propiedades:

Header	Value
`Content-Type`	application/json
`x-authorization`	access_token

Parametros

Parameter	Description
`storeId`	Este es el identificador de la tienda en el lado de Rappi.
`identityType`	Los valores posibles son `RAPPI, SKU`; donde debe utilizar `RAPPI` si los identificadores utilizados para la activación/desactivación son ID de Rappi, y `SKU` si se utilizan identificadores de comerciante.

Ejemplo de solicitud

Este es un ejemplo de una solicitud de API que utiliza este endpoint:

PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock

Este es un ejemplo de la solicitud:

{
  "available": ["123123"],
  "unavailable": []
}

Esta tabla describe los atributos que requiere el JSON de su solicitud:

Attributes		Required	Description
`available`	array of strings	`true`	Listado de identificadores de articulos, ya sean SKUs o Rappi IDs, a habilitar.
`unavailable`	array of strings	`true`	Listado de identificadores de articulos, ya sean SKUs o Rappi IDs, que se deshabilitarán .


URL url = new URL("https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/items/RAPPI/stock");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod("PATCH");

httpConn.setRequestProperty("x-authorization", "Bearer <access_token>");
httpConn.setRequestProperty("Content-Type", "application/json");

httpConn.setDoOutput(true);
OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
writer.write("{\n    \"available\": [\n        \"123123\"\n    ],\n    \"unavailable\": [\n    ]\n}");
writer.flush();
writer.close();
httpConn.getOutputStream().close();

InputStream responseStream = httpConn.getResponseCode() / 100 == 2
        ? httpConn.getInputStream()
        : httpConn.getErrorStream();
Scanner s = new Scanner(responseStream).useDelimiter("\\A");
String response = s.hasNext() ? s.next() : "";
System.out.println(response);

Códigos de respuesta

Estos son los posibles códigos de respuesta para este endpoint:

Ejemplo de respuesta

Ejemplo de respuesta exitosa:

{
  "message": "Your request has been accepted"
}

Esta tabla describe los objetos contenidos en el ejemplo de respuesta:

Response Object		Object Description
`message`	string	Muestra el mensaje de que la solicitud ha sido aceptada.

POST Validar disponibilidad de articulos por SKU o ID

Utilice este endpoint para validar la disponibilidad de articulos en masa para una tienda específica.

Endpoint URL

Utilice esta URL para realizar una solicitud con este endpoint:

URL: https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock/status

{NEW_DOMAIN}: Este es tu dominio de país de Rappi. Consulta la lista de dominios de país. Consulta la lista de dominios de país.

Propiedades del endpoint (Encabezados)

Este recurso tiene las siguientes propiedades:

Header	Value
`Content-Type`	application/json
`x-authorization`	access_token

Parametros

Parameter	Description
`storeId`	Este es el identificador de la tienda en el lado de Rappi.
`identityType`	Los valores posibles son `RAPPI, SKU`; donde debes utilizar `RAPPI` si los identificadores utilizados para la activación/desactivación son Rappi ID, y `SKU` si se utilizan identificadores de comerciante.

Solicitud de muestra

Este es un ejemplo de una solicitud de API que utiliza este endpoint:

POST https://api.dev.rappi.com/restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock/status

Este es un ejemplo de la solicitud:

{
  "items": ["123123"]
}

Esta tabla describe los atributos que requiere el JSON en el cuerpo de su solicitud:

Attributes		Required	Description
`items`	array of strings	`true`	Listado de identificadores de articulos, ya sean SKUs o Rappi IDs, a habilitar.


URL url = new URL("https://api.dev.rappi.com/restaurants/menu/v1/stores/{storeId}/items/{identityType}/stock/status");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod("POST");

httpConn.setRequestProperty("x-authorization", "Bearer <access_token>");
httpConn.setRequestProperty("Content-Type", "application/json");

httpConn.setDoOutput(true);
OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
writer.write("{\n\"items\":[\n\"123123\"\n]\n}");
writer.flush();
writer.close();
httpConn.getOutputStream().close();

InputStream responseStream = httpConn.getResponseCode() / 100 == 2
        ? httpConn.getInputStream()
        : httpConn.getErrorStream();
Scanner s = new Scanner(responseStream).useDelimiter("\\A");
String response = s.hasNext() ? s.next() : "";
System.out.println(response);

Códigos de respuesta

Estos son los posibles códigos de respuesta para este endpoint:

Respuesta de muestra

Este es un ejemplo de respuesta:

Ejemplo de respuesta exitosa:

[
  {
    "item_id": 123456,
    "item_sku": "",
    "item_type": "ITEM",
    "stock_out_state": "UNKNOWN"
  }
]

Esta tabla describe los objetos contenidos en el ejemplo de respuesta:

Response Object		Object Description
`item_id`	long	ID del artículo Rappi
`item_sku`	string	Código del artículo.
`item_type`	string	El tipo de artículo puede ser `PRODUCT` `TOPPING` `ITEM`.
`stock_out_state`	string	Estado de stock del artículo.