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:
Resource | Description |
---|---|
PATCH restaurants/menu/v1/stores/{STORE_ID}/products/{IDENTITY_TYPE}/stock | Asynchronously manages the availability of products by SKU or ID in the Rappi app |
PATCH restaurants/menu/v1/stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stock | Asynchronously manages the availability of toppings by SKU or ID in the Rappi app |
PATCH restaurants/menu/v1/stores/{STORE_ID}/items/{IDENTITY_TYPE}/stock | Asynchronously manages the availability of products and toppings by SKU or ID in the Rappi app |
POST restaurants/menu/v1/stores/{StoreId}/products/{IdentityType}/stock/status | Returns the availability of products by SKU or ID in the Rappi app |
POST restaurants/menu/v1/stores/{StoreId}/toppings/{IdentityType}/stock/status | Returns the availability of toppings by SKU or ID in the Rappi app |
POST restaurants/menu/v1/stores/{StoreId}/items/{IdentityType}/stock/status | Returns 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:
Header | Value |
---|---|
Content-Type | application/json |
Accept | application/json |
x-authorization | YOUR_TOKEN |
This table describes the attributes that the JSON
in your request's body requires:
Attributes | Required | Description |
---|---|---|
available array of strings | required | List of identifiers of products, whether they are SKUs or Rappi app IDs, to be enabled. |
unavailable array of strings | required | List 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:
Header | Value |
---|---|
Content-Type | application/json |
Accept | application/json |
x-authorization | YOUR_TOKEN |
This table describes the attributes that the JSON
in your request's body requires:
Attributes | Required | Description |
---|---|---|
available array of strings | required | List of identifiers of toppings, whether they are SKUs or Rappi app IDs, to be enabled. |
unavailable array of strings | required | List 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:
Header | Value |
---|---|
Content-Type | application/json |
Accept | application/json |
x-authorization | YOUR_TOKEN |
This table describes the attributes that the JSON
in your request's body requires:
Attributes | Required | Description |
---|---|---|
available array of strings | required | List of identifiers of items(products and toppings), whether they are SKUs or Rappi app IDs, to be enabled. |
unavailable array of strings | required | List 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:
POST stores/{STORE_ID}/products/{IDENTITY_TYPE}/stock/status
Use this endpoint to check the availability of products in 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/status
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 querying are Rappi app IDs, and SKU
if merchant identifiers are used.
Endpoint Properties (Headers)
This resource has the following properties:
Header | Value |
---|---|
Content-Type | application/json |
Accept | application/json |
x-authorization | YOUR_TOKEN |
This table describes the attributes that the JSON
in your request's body requires:
Attributes | Required | Description |
---|---|---|
products array of strings | required | List of identifiers of products, whether they are SKUs or Rappi app IDs, to be checked. |
Response Codes
These are the possible response codes for this endpoint:
Request Example
Here's an example of an API request using this endpoint: POST https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/products/RAPPI/stock/status
This is an example of the content of the body of the request:
{ "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);
Example of Response
Successful response example:
[ { "item_id": 2136411305, "item_sku": "SKU-1", "item_type": "PRODUCT", "stock_out_state": "AVAILABLE" } ]
This table describes the objects within the sample response::
Object in response | Description |
---|---|
item_id integer | Rappi identifier of the item. |
item_sku string | SKU of the item. |
item_type string | Type of item in the menu. |
stock_out_state string | Indicates item availability. |
These are the possible responses for the request:
- If the request succeeds, the endpoint returns a Success response code.
- If the request fails, the endpoint returns an Error response code with an error message in a
JSON
.
POST stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stock/status
Use this endpoint to check the availability of toppings in 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/status
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 querying are Rappi app IDs, and SKU
if merchant identifiers are used.
Endpoint Properties (Headers)
This resource has the following properties:
Header | Value |
---|---|
Content-Type | application/json |
Accept | application/json |
x-authorization | YOUR_TOKEN |
This table describes the attributes that the JSON
in your request's body requires:
Attributes | Required | Description |
---|---|---|
toppings array of strings | required | List of identifiers of toppings, whether they are SKUs or Rappi app IDs, to be checked. |
Response Codes
These are the possible response codes for this endpoint:
Request Example
Here's an example of an API request using this endpoint: POST https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/toppings/RAPPI/stock/status
This is an example of the content of the body of the request:
{ "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);
Example of Response
Successful response example:
[ { "item_id": 2136411307, "item_sku": "SKU-1", "item_type": "TOPPING", "stock_out_state": "UNAVAILABLE" } ]
This table describes the objects within the sample response::
Object in response | Description |
---|---|
item_id integer | Rappi Identifier of the item. |
item_sku string | Sku of the item. |
item_type string | Type of item in the menu. |
stock_out_state string | Indicates item availability. |
These are the possible responses for the request:
- If the request succeeds, the endpoint returns a Success response code.
- If the request fails, the endpoint returns an Error response code with an error message in a
JSON
.
POST stores/{STORE_ID}/items/{IDENTITY_TYPE}/stock/status
Use this endpoint to check the availability of items in 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/status
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 querying are Rappi app IDs, and SKU
if merchant identifiers are used.
Endpoint Properties (Headers)
This resource has the following properties:
Header | Value |
---|---|
Content-Type | application/json |
Accept | application/json |
x-authorization | YOUR_TOKEN |
This table describes the attributes that the JSON
in your request's body requires:
Attributes | Required | Description |
---|---|---|
items array of strings | required | List of identifiers of items, whether they are SKUs or Rappi app IDs, to be checked. |
Response Codes
These are the possible response codes for this endpoint:
Request Example
Here's an example of an API request using this endpoint: POST https://api.dev.rappi.com/restaurants/menu/v1/stores/11111/items/RAPPI/stock/status
This is an example of the content of the body of the request:
{ "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);
Example of Response
Successful response example:
[ { "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" } ]
This table describes the objects within the sample response::
Object in response | Description |
---|---|
item_id integer | Rappi identifier of the item. |
item_sku string | SKU of the item. |
item_type string | Type of item in the menu. |
stock_out_state string | Indicates item availability. |
These are the possible responses for the request:
- If the request succeeds, the endpoint returns a Success response code.
- If the request fails, the endpoint returns an Error response code with an error message in a
JSON
.