Products Status
Use Utils to check the status of the products in your store.
| Resource | Description |
|---|---|
GET menu/integration/{integrationId} | Return the list of products and toppings with status and their availability |
GET menu/integration/{integrationId}
Use this endpoint to get list of products and toppings with status and their availability.
Endpoint URL
Use this URL to call the endpoint:
https://{COUNTRY_DOMAIN}/api/rest-ops-utils/menu/integration/{integrationId}
{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.{integrationId}: It is the store's identifier from the ally.
Sample Request
This is an example of an API request using this endpoint:
GET https://microservices.dev.rappi.com/api/rest-ops-utils/menu/integration/910001
This is an example of the response:
URL url = new URL("https://microservices.dev.rappi.com/api/rest-ops-utils/menu/integration/910001"); 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());
Endpoint Properties
This resource has the following properties:
| Response formats | JSON |
| Authentication requirements | Token |
Parameters
This endpoint does not permit additional parameters.
Status Codes
These are the possible status codes of the response for this endpoint:
Sample Response
This is an example of the response:
{ "corridors": [ { "id": "2090062012", "name": "Alimentos", "description": "", "storeId": "900113661", "integrationId": "900113662" } ], "products": [ { "id": "2136363834", "sku": "0003339", "name": "Combo Ant. De Lomo", "description": "Combo ant. de lomo", "active": true, "isAvailable": true, "corridorId": "2090062012" } ], "toppingsCategories": [ { "id": "1247309613", "sku": null, "description": "Otros", "productId": "2136363834", "toppings": [ { "id": "341611638", "sku": "0000105", "description": "Anticucho de lomo fino", "activated": true }, { "id": "341611639", "sku": "0003341", "description": "Cusqueña doble malta", "activated": true }, { "id": "341611640", "sku": "0002991", "description": "Aji diablo", "activated": true } ] } ] }
This table describes the attributes that the JSON of your request requires:
| Response Object | Object Description |
|---|---|
corridorsarray of objects | Corridor list from products. |
corridors.idstring | Corridor id. |
corridors.namestring | Corridor name. |
corridors.descriptionstring | Corridor description. |
corridors.storeIdstring | Store Id from corridor. |
corridors.integrationIdstring | Integration id from store from corridor. |
productsarray of objects | Product List. |
products.idstring | Product Id. |
products.skustring | Product SKU. |
products.namestring | Product name. |
products.descriptionstring | Product description. |
products.activestring | Product status. |
products.isAvailablestring | Product availability. |
products.corridorIdstring | Corridor id from product. |
toppingsCategoriesarray of objects | Category list. |
toppingsCategories.idstring | Category id. |
toppingsCategories.descriptionstring | Category description. |
toppingsCategories.productIdstring | Product Id from category. |
toppingsCategories.toppingsarray of objects | Topping list. |
toppingsCategories.toppings.idstring | Topping id. |
toppingsCategories.toppings.skustring | Topping SKU. |
toppingsCategories.toppings.descriptionstring | Topping description. |
toppingsCategories.toppings.activatedstring | Topping status. |
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:
| Object | Description |
|---|---|
messagestring | Descriptive error message |
Sample Response "App Client not found 404"
This is an example of the response "App Client not found 404":
{ "message": "Not found appClient of client id {clientId}" }
This table describes the objects contained in the response example:
| Object | Description |
|---|---|
messagestring | Descriptive error message |
Sample Response "integration Id not found Bad Request 400"
This is an example of the response "integration Id not found Bad Request 400":
{ "message": "IntegrationId {integrationId} not found" }
This table describes the objects contained in the response example:
| Object | Description |
|---|---|
messagestring | Descriptive error message |