Tiendas

Los recursos de Tiendas te permiten interactuar con tus tiendas.

La siguiente tabla describe los diferentes contenidos de los recursos de Tiendas:

Recurso APIDescripción del endpoint
GET stores-paRegresa la lista de tiendas del aliado autenticado.
PUT stores-pa/{storeId}/statusActualiza una tienda a integrada o no integrada

GET stores-pa

Usa este endpoint para obtener las tiendas del aliado autenticado.

URL del Endpoint

Utiliza esta URL para hacer una llamada con este endpoint:

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

{COUNTRY_DOMAIN}: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formato de respuestaJSON
Requerimientos de autenticaciónToken

Parámetros

Este endpoint no permite parámetros adicionales.

Códigos de respuesta

Estos son los posibles códigos de respuesta en este endpoint:

Ejemplo de Llamada

Este es un ejemplo de una llamada API usando este endpoint:

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

Este es un ejemplo de la llamada:

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());



Ejemplo de Respuesta "Success 200"

Este es un ejemplo de la respuesta "Success 200":

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
integrationId
string
Identificador de la tienda en la aplicación de Rappi
rappiId
string
Identificador que Rappi asignó al aliado
name
string
Nombre de la tienda en la aplicación de Rappi

Ejemplo de Respuesta "Invalid credentials 401"

Este es un ejemplo de la respuesta "Invalid credentials 401":

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
message
string
Mensaje descriptivo del error

Ejemplo de Respuesta "App Client no encontrado 404"

Este es un ejemplo de la respuesta "App Client no encontrado 404":

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
message
string
Mensaje descriptivo del error

PUT store-pa integrated status

Usa este endpoint para cambiar una tienda a integrada o no integrada

URL del Endpoint

Utiliza esta URL para hacer una llamada con este endpoint:

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

{COUNTRY_DOMAIN}: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formato de respuestaJSON
Requerimientos de autenticaciónToken

Parámetros

Este endpoint tiene los siguientes parametros:

ParámetroDescripción
{storeId}Path Param. Store Id del lado de rappi
{integrated}Query Param. Indica si la tienda se actualiza a "integrada" (true) o "no integrada" (false)

Códigos de respuesta

Estos son los posibles códigos de respuesta en este endpoint:

Ejemplo de Llamada

Este es un ejemplo de una llamada API usando este endpoint:

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

Este es un ejemplo de la llamada:

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());



Ejemplo de Respuesta "Success 200"

Este es un ejemplo de la respuesta "Success 200" al pasar una tienda a integrada:

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

Este es un ejemplo de la respuesta "Success 200" al pasar una tienda a no integrada:

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

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

Ejemplo de Respuesta "Invalid credentials 401"

Este es un ejemplo de la respuesta "Invalid credentials 401":

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
message
string
Mensaje descriptivo del error

Ejemplo de Respuesta "App Client no encontrado 404"

Este es un ejemplo de la respuesta "App Client no encontrado 404":

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
message
string
Mensaje descriptivo del error

Este es un ejemplo de la respuesta "Error al actualizar la store 400":

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
message
string
Mensaje descriptivo del error

GET store current menu

Usa este endpoint para obtener el menú actual de la tienda.

URL del Endpoint

Utiliza esta URL para hacer una llamada con este endpoint:

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

{COUNTRY_DOMAIN}: Este es tu Dominio por País de Rappi. Mira la lista de Dominios por país.

{STORE_ID}: Este es el identificador de la tienda del lado de Rappi.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formato de respuestaJSON
Requerimientos de autenticaciónToken

Parámetros

Este endpoint no permite parámetros adicionales.

Códigos de respuesta

Estos son los posibles códigos de respuesta en este endpoint:

Ejemplo de Llamada

Este es un ejemplo de una llamada API usando este endpoint:

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

Este es un ejemplo de la llamada:

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());



Ejemplo de Respuesta "Success 200"

Este es un ejemplo de la respuesta "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:" } } ] } ] } ]

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
storeId
string
Identificador de la tienda del lado de Rappi
products
array of objects
Lista de productos de la tienda
products.id
string
Identificador del producto del lado de Rappi
products.name
string
Nombre del producto
products.price
integer
Precio del producto
products.toppings
array of objects
Lista de Toppings del producto
products.toppings.id
string
Identificador del topping del lado de Rappi
products.toppings.name
string
Nombre del topping
products.toppings.price
integer
Precio del topping
products.toppings.category
objects
Categoría del topping
products.toppings.category.id
string
Identificador de la categoría del topping
products.toppings.category.name
string
Nombre de la categoría del topping

Ejemplo de Respuesta "Invalid credentials 401"

Este es un ejemplo de la respuesta "Invalid credentials 401":

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
message
string
Mensaje descriptivo del error

Ejemplo de Respuesta "App Client no encontrado 404"

Este es un ejemplo de la respuesta "App Client no encontrado 404":

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
message
string
Mensaje descriptivo del error

Ejemplo de Respuesta "La tienda no pertenece al App Client 400"

Este es un ejemplo de la respuesta "La tienda no pertenece al App Client 400":

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

Esta tabla describe los objetos dentro de la respuesta de ejemplo:

ObjetoDescripción
message
string
Mensaje descriptivo del error