Availability

The Availability resources allow you to interact with the availability options of your items and stores.

The following table describes the different contents of the Availability resources:

ResourceDescription
PATCH restaurants/menu/v1/stores/{STORE_ID}/products/{IDENTITY_TYPE}/stockAsynchronously manages the availability of products by SKU or ID in the Rappi app
PATCH restaurants/menu/v1/stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stockAsynchronously manages the availability of toppings by SKU or ID in the Rappi app
PATCH restaurants/menu/v1/stores/{STORE_ID}/items/{IDENTITY_TYPE}/stockAsynchronously manages the availability of products and toppings by SKU or ID in the Rappi app

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

Use this endpoint to enable/disable products in bulk for a specific store.

Endpoint URL

Use this URL to make a request with this endpoint:

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

Parameters

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. Check the list of Country Domains. See the list of Country Domains.

{STORE_ID}: This is the store identifier on Rappi's side.

{IDENTITY_TYPE}: Possible values are RAPPI, SKU; where you should use RAPPI if the identifiers used for activation/deactivation are Rappi app IDs, and SKU if merchant identifiers are used.

Endpoint Properties (Headers)

This resource has the following properties:

HeaderValue
Content-Typeapplication/json
Acceptapplication/json
x-authorizationYOUR_TOKEN

This table describes the attributes that the JSON in your request's body requires:

AttributesRequiredDescription
available
array of strings
requiredList of identifiers of products, whether they are SKUs or Rappi app IDs, to be enabled.
unavailable
array of strings
requiredList of identifiers of products, whether they are SKUs or Rappi app IDs, to be disabled.

Response Codes

These are the possible response codes for this endpoint:

Request Example

Here's an example of an API request using this endpoint: PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/products/RAPPI/stock

This is an example of the content of the body of the request:

{ "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);



Example of Response

Successful response example:

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

Use this endpoint to enable/disable toppings in bulk for a specific store.

Endpoint URL

Use this URL to make a request with this endpoint:

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

Parameters

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. Check the list of Country Domains. See the list of Country Domains.

{STORE_ID}: This is the store identifier on Rappi's side.

{IDENTITY_TYPE}: Possible values are RAPPI, SKU; where you should use RAPPI if the identifiers used for activation/deactivation are Rappi app IDs, and SKU if merchant identifiers are used.

Endpoint Properties (Headers)

This resource has the following properties:

HeaderValue
Content-Typeapplication/json
Acceptapplication/json
x-authorizationYOUR_TOKEN

This table describes the attributes that the JSON in your request's body requires:

AttributesRequiredDescription
available
array of strings
requiredList of identifiers of toppings, whether they are SKUs or Rappi app IDs, to be enabled.
unavailable
array of strings
requiredList of identifiers of toppings, whether they are SKUs or Rappi app IDs, to be disabled.

Response Codes

These are the possible response codes for this endpoint:

Request Example

Here's an example of an API request using this endpoint: PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/toppings/RAPPI/stock

This is an example of the content of the body of the request:

{ "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);



Example of Response

Successful response example:

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

Use this endpoint to enable/disable items(products and toppings) in bulk for a specific store.

Endpoint URL

Use this URL to make a request with this endpoint:

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

Parameters

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. Check the list of Country Domains. See the list of Country Domains.

{STORE_ID}: This is the store identifier on Rappi's side.

{IDENTITY_TYPE}: Possible values are RAPPI, SKU; where you should use RAPPI if the identifiers used for activation/deactivation are Rappi app IDs, and SKU if merchant identifiers are used.

Endpoint Properties (Headers)

This resource has the following properties:

HeaderValue
Content-Typeapplication/json
Acceptapplication/json
x-authorizationYOUR_TOKEN

This table describes the attributes that the JSON in your request's body requires:

AttributesRequiredDescription
available
array of strings
requiredList of identifiers of items(products and toppings), whether they are SKUs or Rappi app IDs, to be enabled.
unavailable
array of strings
requiredList of identifiers of items(products and toppings), whether they are SKUs or Rappi app IDs, to be disabled.

Response Codes

These are the possible response codes for this endpoint:

Request Example

Here's an example of an API request using this endpoint: PATCH https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/items/RAPPI/stock

This is an example of the content of the body of the request:

{ "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);



Example of Response

Successful response example: