Stores

The Stores resource enables you to interact with your stores.

The following table describes the different contents of the Stores resource:

API ResourceEndpoint description
GET stores-paReturns the list of stores for the authenticated client
PUT stores-pa/{storeId}/statusUpdate a store to integrated or not integrated

GET stores-pa

Use this endpoint to retrieve the stores of an authenticating ally.

Endpoint URL

Use this URL to make a request with this endpoint:

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.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint does not permit additional parameters.

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

GET https://microservices.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores-pa

This is an example of the request:

URL url = new URL("https://microservices.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Sample Response "Success 200"

This is an example of the response "Success 200":

[ { "integrationId": "111", "rappiId": "890982", "name": "Store 1" }, { "integrationId": "222", "rappiId": "890983", "name": "Store 2" }, { "integrationId": "333", "rappiId": "890983", "name": "Store 3" } ]

This table describes the objects contained in the response example:

ObjectDescription
integrationId
string
Identifier of the store in the Rappi application
rappiId
string
Identifier that Rappi granted the ally
name
string
Name of the store in the Rappi application

Sample Response "Invalid credentials 401"

This is an example of the response "Invalid credentials 401":

{ "message": "Not a valid token" }

This table describes the objects contained in the response example:

ObjectDescription
message
string
Descriptive error message

Sample Response "App Client no encontrado 404"

This is an example of the response "App Client no encontrado 404":

{ "message": "Not found appClient of client id {clientId}" }

This table describes the objects contained in the response example:

ObjectDescription
message
string
Descriptive error message

PUT store-pa integrated status

Use this endpoint to change a store to integrated or to not integrated

URL del Endpoint

Use this URL to make a request with this endpoint:

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

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

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint has the following parameters:

ParameterDescription
{storeId}Path Param. Store Id from rappi
{integrated}Query Param. To indicate whether the store is changed to "integrated" (true) o "not integrated" (false)

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

PUT https://microservices.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores-pa/12345/status?integrated=true

This is an example of the request:

URL url = new URL("https://microservices.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores-pa/12345/status?integrated=true"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("PUT"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Sample Response "Success 200"

This is an example of the response "Success 200" when updating a store to "integrated"

{ "message": "The store {storeid} was changed to integrated {true} successfully." }

This is an example of the response "Success 200" when updating a store to "not integrated"

{ "message": "The store {storeid} was changed to integrated {false} successfully. Please remember to login into the partners app and set the AUTO ACCEPT config" }

This table describes the objects contained in the response example:

ObjetoDescripción
message
string
Mensaje con la información del cambio realizado

Sample Response "Invalid credentials 401"

This is an example of the response "Invalid credentials 401":

{ "message": "Not a valid token" }

This table describes the objects contained in the response example:

ObjectDescription
message
string
Descriptive error message

Sample Response "App Client no encontrado 404"

This is an example of the response "App Client no encontrado 404":

{ "message": "Not found appClient of client id {clientId}" }

This table describes the objects contained in the response example:

ObjectDescription
message
string
Descriptive error message

Sample Response "Error while updating the store 400"

This is an example of the response "Error while updating the store 400":

{ "message": "There was an error trying to change the store {storeId} to integrated: {true|false}. Please contact support team" }

This table describes the objects contained in the response example:

ObjectDescription
message
string
Descriptive error message

GET store current menu

Use this endpoint to retrieve the menu from the stores.

URL del Endpoint

Use this URL to make a request with this endpoint:

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

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

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

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint does not permit additional parameters.

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

GET https://internal-microservices.dev.rappi.com/api/v2/restaurants-integrations-public-api/store/900111941/menu/current

This is an example of the request:

URL url = new URL("http://internal-microservices.dev.rappi.com/api/v2/restaurants-integrations-public-api/store/YOU_STORE/menu/current"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader( new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Sample Response "Success 200"

This is an example of the response "Success 200":

[ { "storeId": "900111941", "products": [ { "id": "2135501578", "name": "2 por 19,90", "price": 52.9, "partnerSku": null, "active": null, "toppings": [ { "id": "340825698", "name": "Batata Grande", "price": 6.9, "partnerSku": null, "active": null, "category": { "id": "1247164425", "name": "Deseja Acompanhamento?" } }, { "id": "340825699", "name": "Pepsi 350ml", "price": 6.9, "partnerSku": null, "active": null, "category": { "id": "1247164426", "name": "Deseja Bebida?" } } ] }, { "id": "2135501683", "name": "4 Sanduíches por R$ 29,80!", "price": 43.6, "partnerSku": null, "active": null, "toppings": [ { "id": "340827238", "name": "Rodeio", "price": 0, "partnerSku": null, "active": null, "category": { "id": "1247164714", "name": "Escolha seu 1º sanduíche:" } } ] } ] } ]

This table describes the objects contained in the response example:

ObjectDescription
storeId
string
Rappi Id from the Store
products
array of objects
List of products
products.id
string
Rappi Id from toppings
products.name
string
Product name
products.price
integer
Product price
products.toppings
array of objects
List of toppings
products.toppings.id
string
Rappi Id from the topping
products.toppings.name
string
Topping name
products.toppings.price
integer
Topping price
products.toppings.category
objects
Topping category
products.toppings.category.id
string
Rappi Id from Topping Category
products.toppings.category.name
string
Topping Category name

Sample Response "Invalid credentials 401"

This is sample response "Invalid credentials 401":

{ "message": "Not a valid token" }

This table describes the objects contained in the response example:

ObjectDescription
message
string
Mensaje descriptivo del error

Sample Response "App Client not found 404"

This is sample response "App Client no encontrado 404":

{ "message": "Not found appClient of client id {clientId}" }

This table describes the objects contained in the response example:

ObjectDescription
message
string
Mensaje descriptivo del error

Sample Response "Store not found in App Client 400"

This is sample response "Store not found in App Client 400":

{ "message": "The stores {storeId} don't belong to the appClient of client id {clientId}" }

This table describes the objects contained in the response example:

ObjectDescription
message
string
Mensaje descriptivo del error