Documentation

Retrieving Stores Data

API Reference

Use the GET stores-pa endpoint to retrieve the following information from your stores.

  • integrationId It is the id of the store that you assign in the integration.
  • rappiId It is the id of the store assigned by Rappi.
  • name It is the name of the store.

Important

The stores to show are those that are only associated with your clientId.

To retrieve this information:

Make a GET request to the following URL.

URL: https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/stores-pa

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

The system returns a JSON response with the information of your stores.

API Reference

Use the GET store/{RAPPI_ID}/menu/current endpoint to retrieve the menu information from your store.

Products

  • id This is Rappi id from the product.
  • name Product name.
  • price Product price.
  • toppings Toppings from the product.

Toppings

  • id This is Rappi id from the topping.
  • name This is name from the Topping.
  • price This is price from the Topping.
  • category This is category information from the Topping.

Topping Category

  • id This is Rappi id from the topping category.
  • name Topping category name.

Important

The stores to show are those that are only associated with your clientId.

To retrieve this information:

Make a GET request to the following URL.

URL: https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/store/{RAPPI_ID}/menu/current

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

{RAPPI_ID}: This is Rappi id from the store.

The system returns a JSON response with the information of your menu from the store.

Check-In Code

API Reference

Use the GET /stores-pa/{storeId}/check-in-code endpoint to obtain the following information from the check-in code assigned to your store.

  • store_id It is the id of the consulted store.
  • code It is the store check-in code assigned by Rappi.
  • created_at It is the creation date of the check-in code assigned for the store.
  • updated_at It is the update date of the check-in code assigned to the store.
  • expired_at It is the expiration date of the check-in code assigned to the store.

Important

The check-in code information to display is for those stores that are associated only with your clientId.

To retrieve this information:

Make a GET request to the following URL.

URL: https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/stores-pa/{storeId}/check-in-code

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

The system returns a JSON response with the check-in code information for the store.