Tiendas
Los recursos de Tiendas te permiten interactuar con tus tiendas.
La siguiente tabla describe los diferentes contenidos de los recursos de Tiendas:
| Recurso API | Descripción del endpoint |
|---|---|
GET stores-pa | Regresa la lista de tiendas del aliado autenticado. |
PUT stores-pa/{storeId}/status | Actualiza una tienda a integrada o no integrada. |
GET stores-pa/{storeId}/check-in-code/ | Regresa el código de registro de una tienda perteneciente a un aliado autenticado. |
GET /stores/integration-status | Verifica qué tiendas están integradas y cuáles no (Self-Onboarding) |
POST /stores/provisioning | Aprovisiona tiendas para una integración en lote (Self-Onboarding) |
POST /stores/deprovisioning | Desaprovisiona tiendas de una integración en lote (Self-Onboarding) |
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 respuesta | JSON |
| Requerimientos de autenticación | Token |
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://api.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores-pa
Este es un ejemplo de la llamada:
URL url = new URL("https://api.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores-pa"); 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:
| Objeto | Descripción |
|---|---|
integrationIdstring | Identificador de la tienda en la aplicación de Rappi |
rappiIdstring | Identificador que Rappi asignó al aliado |
namestring | 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:
| Objeto | Descripción |
|---|---|
messagestring | 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:
| Objeto | Descripción |
|---|---|
messagestring | 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 respuesta | JSON |
| Requerimientos de autenticación | Token |
Parámetros
Este endpoint tiene los siguientes parametros:
| Parámetro | Descripció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://api.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://api.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:
| Objeto | Descripción |
|---|---|
messagestring | 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:
| Objeto | Descripción |
|---|---|
messagestring | 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:
| Objeto | Descripción |
|---|---|
messagestring | 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:
| Objeto | Descripción |
|---|---|
messagestring | 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 respuesta | JSON | |
| Requerimientos de autenticación | Token |
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-api.dev.rappi.com/api/v2/restaurants-integrations-public-api/store/900111941/menu/current
Este es un ejemplo de la llamada:
URL url = new URL("https://internal-api.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:
| Objeto | Descripción |
|---|---|
storeIdstring | Identificador de la tienda del lado de Rappi |
productsarray of objects | Lista de productos de la tienda |
products.idstring | Identificador del producto del lado de Rappi |
products.namestring | Nombre del producto |
products.priceinteger | Precio del producto |
products.toppingsarray of objects | Lista de Toppings del producto |
products.toppings.idstring | Identificador del topping del lado de Rappi |
products.toppings.namestring | Nombre del topping |
products.toppings.priceinteger | Precio del topping |
products.toppings.categoryobjects | Categoría del topping |
products.toppings.category.idstring | Identificador de la categoría del topping |
products.toppings.category.namestring | 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:
| Objeto | Descripción |
|---|---|
messagestring | 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:
| Objeto | Descripción |
|---|---|
messagestring | 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:
| Objeto | Descripción |
|---|---|
messagestring | Mensaje descriptivo del error |
GET stores-pa check in code
Usa este endpoint para obtener el código de registro de una tienda 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/{storeId}/check-in-code
{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 respuesta | JSON |
| Requerimientos de autenticación | Token |
Parámetros
Este endpoint tiene el siguiente parámetro:
| Parámetro | Descripción |
|---|---|
{storeId} | Path Param. Store Id del aliado de rappi |
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://api.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores-pa/900105433/check-in-code
Este es un ejemplo de la llamada:
URL url = new URL("https://api.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores-pa/900105433/check-in-code"); 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":
{ "store_id": 900105433, "code": "8733", "expired_at": "2023-01-25 16:26:35", "created_at": "2023-01-23 13:51:06", "updated_at": "2023-01-24 16:26:35" }
Esta tabla describe los objetos dentro de la respuesta de ejemplo:
| Objeto | Descripción |
|---|---|
store_idint | Identificador de la tienda en la aplicación de Rappi |
codestring | Código de registro de la tienda que asigna Rappi |
expired_atstring | Fecha de expiración del código de registro asignado para la tienda |
created_atstring | Fecha de creación del código de registro asignado para la tienda |
updated_atstring | Fecha de actualización del código de registro asignado para la tienda |
Ejemplo de Respuesta "La tienda consultada no pertenece al App Client 400"
Este es un ejemplo de la respuesta "La tienda consultada no pertenece al App Client 400":
{ "message": "The stores {store_id} don't belong to the appClient of client id {clientId}" }
Esta tabla describe los objetos dentro de la respuesta de ejemplo:
| Objeto | Descripción |
|---|---|
messagestring | Mensaje descriptivo del error |
Ejemplo de Respuesta "Invalid credentials 401"
Este es un ejemplo de la respuesta "Invalid credentials 401":
{ "message": "Access is denied" }
Esta tabla describe los objetos dentro de la respuesta de ejemplo:
| Objeto | Descripción |
|---|---|
messagestring | 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:
| Objeto | Descripción |
|---|---|
messagestring | Mensaje descriptivo del error |
GET integration-status
Utilice este endpoint para verificar qué tiendas ya están integradas y cuáles no. Los IDs de tienda se obtienen automáticamente del email contenido en el JWT del merchant — no se requiere cuerpo en la solicitud.
URL del Endpoint
https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/stores/integration-status
{COUNTRY_DOMAIN}: Es su dominio de país de Rappi. Ver la lista de dominios de país.
Propiedades del Endpoint
| Formato de respuesta | JSON |
| Autenticación requerida | Bearer integrator JWT (X-Authorization) + Bearer merchant id_token (Authorization-Partners) |
Parámetros
| Header | Requerido | Descripción |
|---|---|---|
X-Authorization | requerido | Bearer <integrator JWT> — token M2M emitido por Auth0 |
Authorization-Partners | requerido | Bearer <merchant id_token> — id_token OIDC emitido por Auth0 (no el access_token); el email se extrae internamente para identificar las tiendas del merchant |
Códigos de Estado
Ejemplo de Solicitud
GET https://api.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores/integration-status
Ejemplo de Respuesta "Exitoso 200"
Este es un ejemplo de la respuesta "Exitoso 200":
{ "stores": [ { "store_id": "1", "name": "Your Brand Main", "brand": "YourBrand", "integrated": true, "integration_id": "your-integration-id", "children": [ { "store_id": "3", "name": "Child Store 3", "brand": "YourBrand", "integrated": true, "integration_id": "your-integration-id" }, { "store_id": "4", "name": "Child Store 4", "brand": "YourBrand", "integrated": false } ] }, { "store_id": "2", "name": "Your Brand Secondary", "brand": "YourBrand", "integrated": true, "integration_id": "your-integration-id", "children": [] }, { "store_id": "10", "name": "Sertester1", "brand": "YourBrand", "integrated": false, "children": [ { "store_id": "20", "name": "Sertester1 Child 1", "brand": "YourBrand", "integrated": false }, { "store_id": "21", "name": "Sertester1 Child 2", "brand": "YourBrand", "integrated": false } ] }, { "store_id": "11", "name": "FIFOUno", "brand": "YourBrand", "integrated": false, "children": [] } ] }
Esta tabla describe los objetos contenidos en el ejemplo de respuesta:
| Objeto | Descripción |
|---|---|
storesarray de objetos | Todas las tiendas padre del merchant (integradas y no integradas). Las tiendas hijas aparecen anidadas en children, no en el nivel superior. |
stores[].store_idstring | ID de la tienda Rappi |
stores[].namestring | Nombre de la tienda |
stores[].brandstring | Nombre de marca resuelto desde Portal Partners |
stores[].integratedboolean | true si la tienda está actualmente integrada; false en caso contrario |
stores[].integration_idstring | Identificador de la integración bajo la cual está provisionada la tienda. Solo presente cuando integrated es true. |
stores[].childrenarray de objetos | Tiendas hijas pertenecientes a este padre. Siempre presente (array vacío si no hay ninguna). |
stores[].children[].store_idstring | ID de la tienda hija |
stores[].children[].namestring | Nombre de la tienda hija |
stores[].children[].brandstring | Nombre de marca de la tienda hija |
stores[].children[].integratedboolean | true si la tienda hija está actualmente integrada; false en caso contrario |
stores[].children[].integration_idstring | Identificador de la integración. Solo presente cuando integrated es true. |
Ejemplo de Respuesta "No autorizado 401"
Este es un ejemplo de la respuesta "No autorizado 401":
{ "message": "Not a valid token" }
| Objeto | Descripción |
|---|---|
messagestring | Mensaje de error descriptivo |
POST provisioning
Utilice este endpoint para aprovisionar tiendas en una integración POS en lote. Esta operación es asincrónica — la API devuelve 202 Accepted de inmediato. El resultado se entrega vía el webhook STORE_PROVISIONING_STATUS.
URL del Endpoint
https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/stores/provisioning
{COUNTRY_DOMAIN}: Es su dominio de país de Rappi. Ver la lista de dominios de país.
Propiedades del Endpoint
| Formato de respuesta | JSON |
| Autenticación requerida | Bearer integrator JWT (X-Authorization) + Bearer merchant id_token (Authorization-Partners) |
Parámetros
| Header | Requerido | Descripción |
|---|---|---|
X-Authorization | requerido | Bearer <integrator JWT> — token M2M emitido por Auth0 |
Authorization-Partners | requerido | Bearer <merchant id_token> — id_token OIDC emitido por Auth0 (no el access_token) |
Cuerpo de la Solicitud
| Atributo | Requerido | Descripción |
|---|---|---|
storesarray de objetos | requerido | Lista de tiendas a aprovisionar. Máximo 20 por solicitud. Cada tienda se aprovisiona según su jerarquía: como hija si se envía parent_store_id; de lo contrario, si ya es hija, se aplana a padre independiente salvo que keep_hierarchy sea true. |
stores[].store_idstring | requerido | ID de la tienda Rappi a aprovisionar (sin prefijo de país). |
stores[].parent_store_idstring | opcional | ID de la tienda padre bajo la cual se aprovisiona esta tienda. El padre debe pertenecer al mismo merchant, ser distinto de la propia tienda, no ser hija de otra y estar ya integrado en la misma integración. La jerarquía se limita a dos niveles: una tienda que ya tiene hijas, o que otro ítem del mismo lote nombra como padre, no puede pasar a ser hija (invalid_parent). Si la tienda ya es hija de otro padre, se reasigna al padre indicado; si además envía keep_hierarchy: true se rechaza con keep_hierarchy_conflict. Reenviar su padre actual es idempotente. Una tienda con pedidos abiertos no puede cambiar su jerarquía (has_open_orders). |
stores[].keep_hierarchyboolean | opcional | Por defecto false: una tienda que ya es hija en Partners y se envía sin parent_store_id se promueve a padre independiente antes del aprovisionamiento (best-effort). Envíe true para que conserve su padre. |
stores[].namestring | requerido | Nombre de la tienda. Se usa para identificar la tienda en la integración. |
stores[].statusstring | opcional | Estado operacional de la tienda. Valores permitidos: ACTIVE, INACTIVE. Por defecto es ACTIVE si se omite. |
stores[].ping_activeboolean | opcional | Si la tienda debe recibir health checks de ping. Por defecto true. |
stores[].get_menu_activeboolean | opcional | Si la tienda debe recibir solicitudes de pull de menú. Por defecto true. |
stores[].cancellation_eventsboolean | opcional | Si la tienda debe recibir eventos de cancelación de órdenes. Por defecto true. |
stores[].other_eventsboolean | opcional | Si la tienda debe recibir otros eventos de orden (listo, cambios de estado) además de cancelación. Por defecto true. |
stores[].store_integration_idstring | opcional | Tu identificador interno de la tienda (Store ID at POS). Úsalo para mapear la tienda Rappi a tu propio sistema. Si no se proporciona, usa el store_id de Rappi por defecto. |
Códigos de Estado
Ejemplo de Solicitud
POST https://api.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores/provisioning
Este es un ejemplo de la solicitud:
{ "stores": [ { "store_id": "900171885", "name": "Tu Marca Principal", "status": "ACTIVE", "ping_active": true, "get_menu_active": false, "cancellation_events": false, "store_integration_id": "POS-MAIN-001" }, { "store_id": "900171886", "name": "Tu Marca - Sucursal A", "status": "ACTIVE", "parent_store_id": "900171885", "ping_active": true, "store_integration_id": "POS-LOC-A" }, { "store_id": "900171887", "name": "Tu Marca - Sucursal B", "status": "INACTIVE", "keep_hierarchy": false } ] }
Ejemplo de Respuesta "Aceptado 202"
Este es un ejemplo de la respuesta "Aceptado 202":
{ "batch_id": "550e8400-e29b-41d4-a716-446655440000", "accepted": [ { "store_id": "900171885", "integration_id": "your-integration-id" }, { "store_id": "900171886", "integration_id": "your-integration-id" } ], "rejected": [{ "store_id": "900171887", "reason": "not_owned" }] }
| Objeto | Descripción |
|---|---|
batch_idstring | Identificador único de la operación en lote. Referenciado en el webhook STORE_PROVISIONING_STATUS. |
acceptedarray de objetos | Tiendas aceptadas para aprovisionamiento, con la jerarquía aplicada. |
accepted[].store_idstring | ID de la tienda Rappi |
accepted[].integration_idstring | Identificador de la integración |
rejectedarray de objetos | Tiendas rechazadas y no aprovisionadas |
rejected[].store_idstring | ID de la tienda Rappi |
rejected[].reasonstring | Motivo del rechazo. Ver la tabla de motivos de rechazo a continuación. |
Motivos de rechazo:
| Motivo | Descripción |
|---|---|
not_owned | La tienda no pertenece al merchant autenticado. |
missing_name | No se envió name. |
invalid_status | status no es ACTIVE ni INACTIVE. |
missing_brand_name | Partners no devolvió el nombre de la marca de la tienda. |
invalid_parent | El padre no es válido o la tienda no puede pasar a ser hija (ver parent_store_id). |
keep_hierarchy_conflict | La tienda ya es hija de otro padre y se envió keep_hierarchy: true junto con un padre distinto. Omita keep_hierarchy (o envíe false) para reasignarla. |
has_open_orders | La tienda tiene pedidos abiertos y no puede cambiar su jerarquía. |
open_orders_check_failed | No se pudo verificar si hay pedidos abiertos, por lo que no se cambió la jerarquía. Reintente más tarde. |
promotion_failed | Falló la actualización de la jerarquía en Partners. |
Ejemplo de Respuesta "No autorizado 401"
Este es un ejemplo de la respuesta "No autorizado 401":
{ "message": "Not a valid token" }
| Objeto | Descripción |
|---|---|
messagestring | Mensaje de error descriptivo |
POST deprovisioning
Utilice este endpoint para desaprovisionar tiendas de una integración POS en lote. Esta operación es asincrónica — la API devuelve 202 Accepted de inmediato. El resultado se entrega vía el webhook STORE_PROVISIONING_STATUS con operation: DEPROVISION y status: INACTIVE por tienda.
URL del Endpoint
https://{COUNTRY_DOMAIN}/api/v2/restaurants-integrations-public-api/stores/deprovisioning
{COUNTRY_DOMAIN}: Es su dominio de país de Rappi. Ver la lista de dominios de país.
Propiedades del Endpoint
| Formato de respuesta | JSON |
| Autenticación requerida | Bearer integrator JWT (X-Authorization) + Bearer merchant id_token (Authorization-Partners) |
Parámetros
| Header | Requerido | Descripción |
|---|---|---|
X-Authorization | requerido | Bearer <integrator JWT> — token M2M emitido por Auth0 |
Authorization-Partners | requerido | Bearer <merchant id_token> — id_token OIDC emitido por Auth0 (no el access_token) |
Cuerpo de la Solicitud
| Atributo | Requerido | Descripción |
|---|---|---|
storesarray de objetos | requerido | Lista de tiendas a desaprovisionar. Máximo 20 por solicitud. |
stores[].store_idstring | requerido | ID de la tienda Rappi a desaprovisionar |
Códigos de Estado
Ejemplo de Solicitud
POST https://api.dev.rappi.com/api/v2/restaurants-integrations-public-api/stores/deprovisioning
Este es un ejemplo de la solicitud:
{ "stores": [{ "store_id": "10" }] }
Ejemplo de Respuesta "Aceptado 202"
Este es un ejemplo de la respuesta "Aceptado 202":
{ "batch_id": "550e8400-e29b-41d4-a716-446655440000", "accepted": [{ "store_id": "10", "integration_id": "your-integration-id" }], "rejected": [ { "store_id": "5", "reason": "has_integrated_children", "integrated_children": ["50", "51"] } ] }
| Objeto | Descripción |
|---|---|
batch_idstring | Identificador único de la operación en lote. Referenciado en el webhook STORE_PROVISIONING_STATUS. |
acceptedarray de objetos | Tiendas aceptadas para desaprovisionamiento |
accepted[].store_idstring | ID de la tienda Rappi |
accepted[].integration_idstring | Identificador de la integración |
rejectedarray de objetos | Tiendas rechazadas y no desaprovisionadas |
rejected[].store_idstring | ID de la tienda Rappi |
rejected[].reasonstring | Motivo del rechazo: not_owned, not_integrated, has_integrated_children |
rejected[].integrated_childrenarray de strings | Presente solo cuando reason es has_integrated_children. Lista los IDs de tiendas hijas que deben desaprovisionarse primero. |
Ejemplo de Respuesta "No autorizado 401"
Este es un ejemplo de la respuesta "No autorizado 401":
{ "message": "Not a valid token" }
| Objeto | Descripción |
|---|---|
messagestring | Mensaje de error descriptivo |
