Managing Availability

API Reference

The Rappi API enables you to configure the availability of your menu items and your stores, by using the items resource with the new domains.

The following sections guide you through the process of configuring these options for your integration.

Item Availability

Configure the availability of your menu items and disable them when they are out of stock, to prevent incoming orders that contain unavailable products.

The Rappi API enables you to configure availability by:

Item SKU: This is the SKU you provided for the item to the Rappi when uploading to the menu.
Item ID: This is the identifier that Rappi provided you when uploading to the menu.

Setting Availability of Products by SKU or ID

API Reference

Use the PATCH stores/{store_id}/products/{identity_type}/stock endpoint to configure the availability of your products by item SKU or item ID from a specific store.

To configure the availability of your products:

Make a PATCH request to the following URL, and add a JSON to the body of the request with the following objects.

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.
{STORE_ID}: This is the identifier of your store.
{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.

This is an example of the JSON in the body of the request:

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

Note

The values from this JSON object are not real data. Ensure to replace them with your own data when making API requests. You can add more products to the available and unavailable JSON objects separated by a comma.

The system return a Status Code '202'.

Setting Availability of Toppings by SKU or ID

API Reference

Use the PATCH stores/{STORE_ID}/toppings/{IDENTITY_TYPE}/stock endpoint to configure the availability of your toppings by item SKU or item ID from a specific store.

To configure the availability of your toppings:

Make a PATCH request to the following URL, and add a JSON to the body of the request with the following objects.

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.
{STORE_ID}: This is the identifier of your store.
{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.

This is an example of the JSON in the body of the request:

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

Note

The system return a Status Code '202'.

Setting Availability of Items by SKU or ID

API Reference

Use the PATCH stores/{STORE_ID}/items/{IDENTITY_TYPE}/stock endpoint to configure the availability of your items by item SKU or item ID from a specific store.

To configure the availability of your items:

Make a PATCH request to the following URL, and add a JSON to the body of the request with the following objects.

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.
{STORE_ID}: This is the identifier of your store.
{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.

This is an example of the JSON in the body of the request:

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

Note

The values from this JSON object are not real data. Ensure to replace them with your own data when making API requests. You can add more items to the available and unavailable JSON objects separated by a comma.

The system return a Status Code '202'.

Consulting the Availability of Products by SKU or ID

API Reference

Use the POST stores/{store_id}/products/{identity_type}/stock/status endpoint to query the availability of your products by item SKU or item ID from a specific store.

To check the availability of your products:

Make a POST request to the following URL, and add a JSON to the body of the request with the following objects.

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.
{STORE_ID}: This is the identifier of your store.
{IDENTITY_TYPE}: Possible values are RAPPI, SKU; where you should use RAPPI if the identifiers used for the query are Rappi app IDs, and SKU if merchant identifiers are used.

This is an example of the JSON in the body of the request:

{
  "products": ["2136854048"]
}

Note

The values from this JSON object are not real data. Ensure to replace them with your own data when making API requests. You can add more elements to the products object in the JSON, separated by a comma.

Here is an example of the JSON response:

[
  {
    "item_id": 2136411305,
    "item_type": "PRODUCT",
    "stock_out_state": "AVAILABLE"
  }
]

Consulting the Availability of Toppings by SKU or ID

API Reference

Use the POST stores/{store_id}/toppings/{identity_type}/stock/status endpoint to query the availability of your toppings by item SKU or item ID from a specific store.

To check the availability of your toppings:

Make a POST request to the following URL, and add a JSON to the body of the request with the following objects.

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.
{STORE_ID}: This is the identifier of your store.
{IDENTITY_TYPE}: Possible values are RAPPI, SKU; where you should use RAPPI if the identifiers used for the query are Rappi app IDs, and SKU if merchant identifiers are used.

This is an example of the JSON in the body of the request:

{
  "toppings": ["2136854048"]
}

Note

The values from this JSON object are not real data. Ensure to replace them with your own data when making API requests. You can add more elements to the toppings object in the JSON, separated by a comma.

Here is an example of the JSON response:

[
  {
    "item_id": 2136411307,
    "item_type": "TOPPING",
    "stock_out_state": "UNAVAILABLE"
  }
]

Consulting the Availability of Items by SKU or ID

API Reference

Use the POST stores/{store_id}/items/{identity_type}/stock/status endpoint to query the availability of your items by item SKU or item ID from a specific store.

To check the availability of your items:

Make a POST request to the following URL, and add a JSON to the body of the request with the following objects.

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.
{STORE_ID}: This is the identifier of your store.
{IDENTITY_TYPE}: Possible values are RAPPI, SKU; where you should use RAPPI if the identifiers used for the query are Rappi app IDs, and SKU if merchant identifiers are used.

This is an example of the JSON in the body of the request:

{
  "items": ["2136854048"]
}

Note

The values from this JSON object are not real data. Ensure to replace them with your own data when making API requests. You can add more elements to the items object in the JSON, separated by a comma.

Here is an example of the JSON response:

[
  {
    "item_id": 2136411305,
    "item_type": "PRODUCT",
    "stock_out_state": "AVAILABLE"
  },
  {
    "item_id": 2136411307,
    "item_type": "TOPPING",
    "stock_out_state": "UNAVAILABLE"
  },
  {
    "item_id": 2136411304,
    "item_type": "PRODUCT",
    "stock_out_state": "UNKNOWN"
  }
]