Documentación

Disponibilidad

Los recursos de Disponibilidad te permiten interactuar con las opciones de disponibilidad de tus artículos y tiendas.

La siguiente tabla describe los diferentes contenidos de los recursos de Disponibilidad:

RecursoDescripción
PATCH restaurants/menu/v1/stores/{STORE_ID}/products/{IDENTITY_TYPE}/stockManeja de forma asincrónica la disponibilidad de los productos por SKU o por ID en la app de Rappi
PATCH restaurants/menu/v1/stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stockManeja de forma asincrónica la disponibilidad de los toppings por SKU o por ID en la app de Rappi
PATCH restaurants/menu/v1/stores/{STORE_ID}/items/{IDENTITY_TYPE}/stockManeja de forma asincrónica la disponibilidad de los productos y toppings por SKU o por ID en la app de Rappi
POST restaurants/menu/v1/stores/{StoreId}/products/{IdentityType}/stock/statusRetorna la disponibilidad de los productos por SKU o por ID en la app de Rappi
POST restaurants/menu/v1/stores/{StoreId}/toppings/{IdentityType}/stock/statusRetorna la disponibilidad de los toppings por SKU o por ID en la app de Rappi
POST restaurants/menu/v1/stores/{StoreId}/items/{IdentityType}/stock/statusRetorna la disponibilidad de los productos y toppings por SKU o por ID en la app de Rappi

PATCH stores/{STORE_ID}/products/{IDENTITY_TYPE}/stock

Usa este endpoint para habilitar/deshabilitar productos de manera masiva para una tienda en específico

URL del Endpoint

Utiliza esta URL para hacer una llamada con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/menu/v1/stores/{STORE_ID}/products/{IDENTITY_TYPE}/stock

Parámetros

{COUNTRY_DOMAIN}: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.

{STORE_ID}: Este es el identificador de la tienda del lado de Rappi.

{IDENTITY_TYPE}: Valores posibles RAPPI, SKU; donde se debe usar RAPPI si los identificadores que se usaran para activar/desactivar son ID de articulos en la app de Rappi, y SKU si se usaran los identificadores del comercio.

Propiedades del Endpoint (cabeceros)

Este recurso tiene las siguientes propiedades:

CabeceroValor
Content-Typeapplication/json
Acceptapplication/json
x-authorizationTU_TOKEN

Esta tabla describe los atributos que el JSON de el body de tu llamada requiere:

AtributosRequeridoDescripción
available
array of strings		requeridoLista de los identificadores de los productos bien sean SKU o ID's de la tienda del lado de Rappi que van a ser habilitados.
unavailable
array of strings		requeridoLista de los identificadores de los productos bien sean SKU o ID's de la tienda del lado de Rappi que van a ser deshabilitados.

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: PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/products/RAPPI/stock

Este es un ejemplo de contenido del body de la llamada:

{
  "available": ["123123"],
  "unavailable": []
}
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 YOUR_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);






Ejemplo de Respuesta




Ejemplo de respuesta exitosa:





PATCH stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stock




Usa este endpoint para habilitar/deshabilitar toppings de manera masiva para una tienda en específico




URL del Endpoint




Utiliza esta URL para hacer una llamada con este endpoint:




https://{COUNTRY_DOMAIN}/restaurants/menu/v1/stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stock


Parámetros


{COUNTRY_DOMAIN}: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.


{STORE_ID}: Este es el identificador de la tienda del lado de Rappi.


{IDENTITY_TYPE}: Valores posibles RAPPI, SKU; donde se debe usar RAPPI si los identificadores que se usaran para activar/desactivar son ID de articulos en la app de Rappi, y SKU si se usaran los identificadores del comercio.



Propiedades del Endpoint (cabeceros)


Este recurso tiene las siguientes propiedades:























CabeceroValor
Content-Typeapplication/json
Acceptapplication/json
x-authorizationTU_TOKEN



Esta tabla describe los atributos que el JSON de el body de tu llamada requiere:






















AtributosRequeridoDescripción
available
array of strings		requeridoLista de los identificadores de los toppings bien sean SKU o ID's de la tienda del lado de Rappi que van a ser habilitados.
unavailable
array of strings		requeridoLista de los identificadores de los toppings bien sean SKU o ID's de la tienda del lado de Rappi que van a ser deshabilitados.


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: PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/toppings/RAPPI/stock


Este es un ejemplo de contenido del body de la llamada:


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


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 YOUR_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);








Ejemplo de Respuesta




Ejemplo de respuesta exitosa:





PATCH stores/{STORE_ID}/items/{IDENTITY_TYPE}/stock




Usa este endpoint para habilitar/deshabilitar items(productos y toppings) de manera masiva para una tienda en específico




URL del Endpoint




Utiliza esta URL para hacer una llamada con este endpoint:




https://{COUNTRY_DOMAIN}/restaurants/menu/v1/stores/{STORE_ID}/items/{IDENTITY_TYPE}/stock


Parámetros


{COUNTRY_DOMAIN}: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.


{STORE_ID}: Este es el identificador de la tienda del lado de Rappi.


{IDENTITY_TYPE}: Valores posibles RAPPI, SKU; donde se debe usar RAPPI si los identificadores que se usaran para activar/desactivar son ID de articulos en la app de Rappi, y SKU si se usaran los identificadores del comercio.



Propiedades del Endpoint (cabeceros)


Este recurso tiene las siguientes propiedades:























CabeceroValor
Content-Typeapplication/json
Acceptapplication/json
x-authorizationTU_TOKEN



Esta tabla describe los atributos que el JSON de el body de tu llamada requiere:






















AtributosRequeridoDescripción
available
array of strings		requeridoLista de los identificadores de los items(productos y toppings) bien sean SKU o ID's de la tienda del lado de Rappi que van a ser habilitados.
unavailable
array of strings		requeridoLista de los identificadores de los items(productos y toppings) bien sean SKU o ID's de la tienda del lado de Rappi que van a ser deshabilitados.


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: PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/items/RAPPI/stock


Este es un ejemplo de contenido del body de la llamada:


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


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 YOUR_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);








Ejemplo de Respuesta




Ejemplo de respuesta exitosa:





POST stores/{STORE_ID}/products/{IDENTITY_TYPE}/stock/status




Usa este endpoint para consultar la disponibilidad de los productos de una tienda en específico




URL del Endpoint




Utiliza esta URL para hacer una llamada con este endpoint:




https://{COUNTRY_DOMAIN}/restaurants/menu/v1/stores/{STORE_ID}/products/{IDENTITY_TYPE}/stock/status


Parámetros


{COUNTRY_DOMAIN}: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.


{STORE_ID}: Este es el identificador de la tienda del lado de Rappi.


{IDENTITY_TYPE}: Los valores posibles son RAPPI, SKU; donde se debe usar RAPPI si los identificadores que se usaran para consultar son IDs de articulos en la app de Rappi, y SKU si se usaran los identificadores del comercio.



Propiedades del Endpoint (cabeceros)


Este recurso tiene las siguientes propiedades:























CabeceroValor
Content-Typeapplication/json
Acceptapplication/json
x-authorizationTU_TOKEN



Esta tabla describe los atributos que el JSON del body de tu llamada requiere:

















AtributosRequeridoDescripción
products
array of strings		requeridoLista de los identificadores de los productos bien sean SKU o ID's de la tienda del lado de Rappi que van a ser consultados.


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: PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/products/RAPPI/stock/status


Este es un ejemplo de contenido del body de la llamada:


{
  "products": ["123123"]
}


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

httpConn.setRequestProperty("x-authorization", "Bearer YOUR_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);








Ejemplo de Respuesta




Ejemplo de respuesta exitosa:




[
  {
    "item_id": 2136411305,
    "item_sku": "SKU-1",
    "item_type": "PRODUCT",
    "stock_out_state": "AVAILABLE"
  }
]


Esta tabla describe los objetos dentro de la respuesta de ejemplo:



























Objeto en la respuestaDescripción del objeto
item_id
integer		Identificador de Rappi del item dentro del menú de la tienda.
item_sku
integer		SKU del item dentro del menú de la tienda.
item_type
string		Tipo de item en el menú.
stock_out_state
string		Indica la disponibilidad del item


Estos son las respuestas posibles al hacer la llamada:


    

  • Si la llamada es exitosa, el endpoint regresa un código Success.
    • 

  • Si la llamada falla, el endpoint regresa un código de Error con un mensaje en formato JSON.
    • 



POST stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stock/status




Usa este endpoint para consultar la disponibilidad de los toppings de una tienda en específico




URL del Endpoint




Utiliza esta URL para hacer una llamada con este endpoint:




https://{COUNTRY_DOMAIN}/restaurants/menu/v1/stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stock/status


Parámetros


{COUNTRY_DOMAIN}: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.


{STORE_ID}: Este es el identificador de la tienda del lado de Rappi.


{IDENTITY_TYPE}: Los valores posibles son RAPPI, SKU; donde se debe usar RAPPI si los identificadores que se usaran para consultar son IDs de articulos en la app de Rappi, y SKU si se usaran los identificadores del comercio.



Propiedades del Endpoint (cabeceros)


Este recurso tiene las siguientes propiedades:























CabeceroValor
Content-Typeapplication/json
Acceptapplication/json
x-authorizationTU_TOKEN



Esta tabla describe los atributos que el JSON del body de tu llamada requiere:

















AtributosRequeridoDescripción
toppings
array of strings		requeridoLista de los identificadores de los toppings bien sean SKU o ID's de la tienda del lado de Rappi que van a ser consultados.


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: PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/toppings/RAPPI/stock/status


Este es un ejemplo de contenido del body de la llamada:


{
  "toppings": ["123123"]
}


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

httpConn.setRequestProperty("x-authorization", "Bearer YOUR_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);








Ejemplo de Respuesta




Ejemplo de respuesta exitosa:




[
  {
    "item_id": 2136411307,
    "item_sku": "SKU-2",
    "item_type": "TOPPING",
    "stock_out_state": "UNAVAILABLE"
  }
]


Esta tabla describe los objetos dentro de la respuesta de ejemplo:



























Objeto en la respuestaDescripción del objeto
item_id
integer		Identificador de Rappi del item dentro del menú de la tienda.
item_sku
string		SKU del item dentro del menú de la tienda.
item_type
string		Tipo de item en el menú.
stock_out_state
string		Indica la disponibilidad del item


Estos son las respuestas posibles al hacer la llamada:


    

  • Si la llamada es exitosa, el endpoint regresa un código Success.
    • 

  • Si la llamada falla, el endpoint regresa un código de Error con un mensaje en formato JSON.
    • 



POST stores/{STORE_ID}/items/{IDENTITY_TYPE}/stock/status




Usa este endpoint para consultar la disponibilidad de los items de una tienda en específico




URL del Endpoint




Utiliza esta URL para hacer una llamada con este endpoint:




https://{COUNTRY_DOMAIN}/restaurants/menu/v1/stores/{STORE_ID}/items/{IDENTITY_TYPE}/stock/status


Parámetros


{COUNTRY_DOMAIN}: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.


{STORE_ID}: Este es el identificador de la tienda del lado de Rappi.


{IDENTITY_TYPE}: Los valores posibles son RAPPI, SKU; donde se debe usar RAPPI si los identificadores que se usaran para consultar son IDs de articulos en la app de Rappi, y SKU si se usaran los identificadores del comercio.



Propiedades del Endpoint (cabeceros)


Este recurso tiene las siguientes propiedades:























CabeceroValor
Content-Typeapplication/json
Acceptapplication/json
x-authorizationTU_TOKEN



Esta tabla describe los atributos que el JSON del body de tu llamada requiere:

















AtributosRequeridoDescripción
items
array of strings		requeridoLista de los identificadores de los items bien sean SKU o ID's de la tienda del lado de Rappi que van a ser consultados.


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: PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/items/RAPPI/stock/status


Este es un ejemplo de contenido del body de la llamada:


{
  "items": ["123123"]
}


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

httpConn.setRequestProperty("x-authorization", "Bearer YOUR_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);








Ejemplo de Respuesta




Ejemplo de respuesta exitosa:




[
  {
    "item_id": 2136411305,
    "item_sku": "SKU-1",
    "item_type": "PRODUCT",
    "stock_out_state": "AVAILABLE"
  },
  {
    "item_id": 2136411307,
    "item_sku": "SKU-2",
    "item_type": "TOPPING",
    "stock_out_state": "UNAVAILABLE"
  },
  {
    "item_id": 2136411304,
    "item_sku": "SKU-3",
    "item_type": "PRODUCT",
    "stock_out_state": "UNKNOWN"
  }
]


Esta tabla describe los objetos dentro de la respuesta de ejemplo:



























Objeto en la respuestaDescripción del objeto
item_id
integer		Identificador de Rappi del item dentro del menú de la tienda.
item_sku
string		SKU del item dentro del menú de la tienda.
item_type
string		Tipo de item en el menú.
stock_out_state
string		Indica la disponibilidad del item


Estos son las respuestas posibles al hacer la llamada:


    

  • Si la llamada es exitosa, el endpoint regresa un código Success.
    • 

  • Si la llamada falla, el endpoint regresa un código de Error con un mensaje en formato JSON.
    •