Items

Representa todo el catálogo que ofrece la tienda. Pueden ser de dos tipos:

ITEM MODIFIER_GROUP Solo items de tipo ITEM pueden estar debajo de un categoría y solo pueden estar relacionados con items de diferentes tipos: ITEM -> MODIFIER_GROUP / MODIFIER_GROUP -> ITEM.

Conceptualmente un item de tipo ITEM puede ser un producto o un modificador y un item de tipo MODIFIER_GROUP es un grupo de modificadores.

La siguiente tabla describe los recursos de Ítems disponibles:

recursoDescripción del endpoint
GET v1/stores/{store_id}/itemsRecupera los artículos de una tienda por ID de tienda.
POST v1/stores/{store_id}/itemsCrea o actualiza los artículos por ID de tienda..
DELETE v1/stores/{store_id}/itemsElimina los artículos específicos por ID de tienda.
GET v1/stores/{store_id}/items/{item_id}RRecupera el artículo específico con todas las relaciones de información por ID de tienda.

GET Items por ID de tienda

Este endpoint recupera la lista de artículos disponibles en una tienda específica.

URL del Endpoint

Utiliza esta URL para realizar una solicitud con este endpoint:

https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{store_id}/items

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

Propiedades del Endpoint

Este recurso tienes las siguiente propiedades:

Formato de respuestaJSON
Requerimientos de autenticaciónToken

Parámetros

Este endpoint tiene los siguientes parámetros:

ParámetroTipoRequeridoDescripción
store_iduint64El identificador único de la tienda cuyo menú se está solicitando.

This parameter is used to specify which store's menu should be retrieved. The store_id should be a valid integer representing a store registered in the system.

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/restaurants/menu/v1/stores/{store_id}/items

Este es un ejemplo de la llamada:


String storeId = "232"; String urlString = "https://api.dev.rappi.com/restaurants/menu/v1/stores/" + storeId + "/items"; URL url = new URL(urlString); 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"); int responseCode = connection.getResponseCode(); System.out.println("Response Code: " + responseCode); 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()); }



Sample Response "Success 200"

Este es un ejemplo de una respuesta "200 Exitoso":

[ { "id": 100, "sku": "pastel_de_fresa", "store_id": 232, "last_updated": "2025-03-27T22:01:41.647471Z", "item_type": "ITEM", "title_info": { "title": "Pastel de fresa", "overrides": [ { "override_id": 641, "override_sku": "", "override_type": "STORE", "title": "Pastel de fresa deluxe" }, { "override_id": 714, "override_sku": "1248187953", "override_type": "ITEM", "title": "Acompañamiento: Pastel de fresa" } ] }, "description_info": { "description": "Delicioso pastel de fresa", "overrides": [ { "override_id": 641, "override_type": "STORE", "description": "Delicioso pastel de fresa deluxe", "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "description": "Delicioso acompañamiento: Pastel de fresa", "override_sku": "1248187953" } ] }, "images_info": { "images": [ { "id": 34, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com" } ], "overrides": [ { "override_id": 641, "override_type": "STORE", "images": [ { "id": 43, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com" } ], "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "images": [ { "id": 43544, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com" } ], "override_sku": "1248187953" } ] }, "items_info": { "items": [ { "id": 11743, "sku": "1248187964", "index": 1 } ], "overrides": [ { "override_id": 714, "override_type": "ITEM", "items": [ { "id": 11720, "sku": "1248187730", "index": 1 } ], "override_sku": "1248187953" }, { "override_id": 641, "override_type": "STORE", "items": [ { "id": 11716, "sku": "1248187776", "index": 1 } ], "override_sku": "" } ] }, "price_info": { "price": 179, "overrides": [ { "override_id": 641, "override_type": "STORE", "price": 200, "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "price": 0, "override_sku": "1248187953" } ] }, "quantity_info": { "min_permitted": 0, "max_permitted": 5, "modifiers_type": null, "overrides": [ { "override_id": 641, "override_type": "STORE", "min_permitted": 0, "max_permitted": 2, "modifiers_type": null, "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "min_permitted": 0, "max_permitted": 1, "modifiers_type": null, "override_sku": "1248187953" } ] }, "suspension_info": { "suspend_until": null, "suspend_reason": null, "overrides": [ { "override_id": 641, "override_type": "STORE", "suspend_until": "2025-03-30T00:00:00Z", "suspend_reason": "Is stocked out", "created_at": "2025-03-27T22:01:41.647376Z", "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "suspend_until": "2025-03-30T00:00:00Z", "suspend_reason": "Is stocked out", "created_at": "2025-03-27T22:01:41.647376Z", "override_sku": "1248187953" } ], "is_available": true }, "schedules_info": { "schedules": [ { "days_of_week": "mon,tue,wed,thu,fri", "time_periods": [ { "start_time": "16:00", "end_time": "22:00" } ] } ], "overrides": [ { "id": 26, "override_id": 641, "override_sku": "", "override_type": "STORE", "schedules": [ { "days_of_week": "mon,tue,wed,thu,fri", "time_periods": [ { "start_time": "16:00", "end_time": "23:00" } ] } ] }, { "id": 27, "override_id": 714, "override_sku": "1248187953", "override_type": "ITEM", "schedules": [ { "days_of_week": "mon,tue,wed,thu,fri", "time_periods": [ { "start_time": "16:00", "end_time": "20:00" } ] } ] } ] } }, { "id": 11, "sku": "1abc", "store_id": 232, "last_updated": "2024-12-18T14:58:24.552489Z", "item_type": "MODIFIER_GROUP", "title_info": { "title": "Eleccion cubiertos", "overrides": [] }, "description_info": { "description": "Eleccion cubiertos", "overrides": [] }, "images_info": { "images": [], "overrides": [] }, "items_info": { "items": [], "overrides": [] }, "price_info": { "price": 0, "overrides": [] }, "quantity_info": { "min_permitted": 0, "max_permitted": 1, "modifiers_type": "exclusive", "overrides": [] }, "suspension_info": { "suspend_until": null, "suspend_reason": null, "overrides": [], "is_available": true }, "schedules_info": { "schedules": [], "overrides": [] } } ]

POST Upsert Items By Store ID

Este endpoint permite crear o actualizar artículos en una tienda específica.

URL del Endpoint

Usa esta URL para realizar una solicitud con este endpoint:

https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{store_id}/items

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

Propiedades del Endpoint

Este recurso tienes las siguiente propiedades:

Formato de respuestaJSON
Requerimientos de autenticaciónToken

Parámetros

Este endpoint tiene los siguientes parámetros:

ParámetroTipoRequeridoDescripción
store_iduint64El identificador único de la tienda cuyo menú se está solicitando.

This parameter is used to specify which store's menu should be retrieved. The store_id should be a valid integer representing a store registered in the system.

Notas Importantes

Descripción de los Campos de Solicitud

CampoTipoDescripción
idintIdentificador del artículo.
skustringIdentificador de la unidad de mantenimiento de stock (SKU) del artículo. Es obligatorio a menos que se envíe el ID.
store_idintIdentificador de la tienda en la aplicación.
item_typestringTipo de artículo (ITEM o MODIFIER_GROUP).
title_info.titlestringTítulo del artículo.
title_info.overridesarrayLista de modificaciones del título para condiciones específicas.
title_info.overrides[].override_idintIdentificador de la modificación del título.
title_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
title_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
title_info.overrides[].titlestringTítulo modificado.
description_info.descriptionstringDescripción del artículo.
description_info.overridesarrayLista de modificaciones de la descripción para condiciones específicas.
description_info.overrides[].override_idintIdentificador de la modificación de la descripción.
description_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
description_info.overrides[].descriptionstringDescripción modificada.
description_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
images_info.imagesarrayLista de imágenes asociadas con el artículo.
images_info.images[].idintIdentificador de la imagen.
images_info.images[].pathstringRuta donde se encuentra la imagen en el CDN.
images_info.images[].indexintPosición en la que debe mostrarse la imagen.
images_info.images[].hoststringServidor CDN de la imagen.
images_info.overridesarrayLista de modificaciones de imágenes para condiciones específicas.
images_info.overrides[].override_idintIdentificador de la modificación de la imagen.
images_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
images_info.overrides[].imagesarrayLista de imágenes modificadas.
images_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
items_info.itemsarrayLista de artículos relacionados.
items_info.items[].idintIdentificador del artículo relacionado.
items_info.items[].skustringSKU del artículo relacionado. Es obligatorio a menos que se envíe el ID.
items_info.items[].indexintÍndice de orden del artículo relacionado.
items_info.overridesarrayLista de modificaciones de artículos para condiciones específicas.
items_info.overrides[].override_idintIdentificador de la modificación del artículo.
items_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
items_info.overrides[].itemsarrayLista de artículos modificados.
items_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
price_info.pricefloatPrecio del artículo.
price_info.overridesarrayLista de modificaciones de precios para condiciones específicas.
price_info.overrides[].override_idintIdentificador de la modificación del precio.
price_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
price_info.overrides[].pricefloatEl precio que debe aplicarse cuando se cumple la modificación.
price_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
quantity_info.min_permittedintCantidad mínima permitida del artículo o de los elementos dentro del grupo modificador. Obligatorio si el artículo es de tipo MODIFIER_GROUP.
quantity_info.max_permittedintCantidad máxima permitida del artículo o de los elementos dentro del grupo modificador. Obligatorio si el artículo es de tipo MODIFIER_GROUP.
quantity_info.modifiers_typestringTipo de modificador (puede ser nulo).
quantity_info.overridesarrayLista de modificaciones de cantidad para condiciones específicas.
quantity_info.overrides[].override_idintIdentificador de la modificación de cantidad.
quantity_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
quantity_info.overrides[].min_permittedintCantidad mínima permitida del artículo cuando es de tipo ITEM, o la cantidad mínima permitida dentro del grupo cuando es de tipo MODIFIER_GROUP. Obligatorio si el artículo es de tipo MODIFIER_GROUP.
quantity_info.overrides[].max_permittedintCantidad máxima permitida del artículo cuando es de tipo ITEM, o la cantidad máxima permitida dentro del grupo cuando es de tipo MODIFIER_GROUP. Obligatorio si el artículo es de tipo MODIFIER_GROUP.
quantity_info.overrides[].modifiers_typestringTipo de modificador sobrescrito (puede ser nulo).
quantity_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
suspension_info.suspend_untilstringFecha en la que el artículo debe activarse. Si es null, entonces está suspendido permanentemente.
suspension_info.suspend_reasonstringRazón por la cual el artículo está suspendido.
suspension_info.is_availableboolEstado de disponibilidad del artículo.
suspension_info.overridesarrayLista de modificaciones de suspensión para condiciones específicas.
schedules_info.schedulesarrayLista de horarios que definen la disponibilidad.
schedules_info.schedules[].days_of_weekstringDías de la semana en los que el horario está activo.
schedules_info.schedules[].time_periodsarrayPeríodos de tiempo dentro del horario.
schedules_info.schedules[].time_periods[].start_timestringHora de inicio en formato HH:MM.
schedules_info.schedules[].time_periods[].end_timestringHora de finalización en formato HH:MM.
schedules_info.overridesarrayLista de modificaciones de horarios para condiciones específicas.
schedules_info.overrides[].override_idintIdentificador de la modificación del horario.
schedules_info.overrides[].override_typestringTipo de modificación (STORE, CATEGORY o ITEM).
schedules_info.overrides[].schedulesarrayLista de horarios modificados.
schedules_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.

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:

POST https://api.dev.rappi.com/restaurants/menu/v1/stores/900159641/items

Este es un ejemplo de la llamada:


import okhttp3.*; public class Main { public static void main(String[] args) throws Exception { OkHttpClient client = new OkHttpClient(); String json = """ { "id": 100, "sku": "pastel_de_fresa", "store_id": 232, "item_type": "ITEM", "title_info": { "title": "Pastel de fresa", "overrides": [ {"override_id": 641, "override_sku": "", "override_type": "STORE", "title": "Pastel de fresa deluxe"}, {"override_id": 714, "override_sku": "1248187953", "override_type": "ITEM", "title": "Acompañamiento: Pastel de fresa"} ] }, "description_info": { "description": "Delicioso pastel de fresa", "overrides": [ {"override_id": 641, "override_type": "STORE", "description": "Delicioso pastel de fresa deluxe", "override_sku": ""}, {"override_id": 714, "override_type": "ITEM", "description": "Delicioso acompañamiento: Pastel de fresa", "override_sku": "1248187953"} ] }, "images_info": { "images": [ {"id": 34, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com"} ], "overrides": [ {"override_id": 641, "override_type": "STORE", "images": [{"id": 43, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com"}], "override_sku": ""}, {"override_id": 714, "override_type": "ITEM", "images": [{"id": 43544, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com"}], "override_sku": "1248187953"} ] }, "items_info": { "items": [{"id": 11743, "sku": "1248187964", "index": 1}], "overrides": [ {"override_id": 714, "override_type": "ITEM", "items": [{"id": 11720, "sku": "1248187730", "index": 1}], "override_sku": "1248187953"}, {"override_id": 641, "override_type": "STORE", "items": [{"id": 11716, "sku": "1248187776", "index": 1}], "override_sku": ""} ] }, "price_info": { "price": 179, "overrides": [ {"override_id": 641, "override_type": "STORE", "price": 200, "override_sku": ""}, {"override_id": 714, "override_type": "ITEM", "price": 0, "override_sku": "1248187953"} ] }, "quantity_info": { "min_permitted": 0, "max_permitted": 5, "overrides": [ {"override_id": 641, "override_type": "STORE", "min_permitted": 0, "max_permitted": 2, "override_sku": ""}, {"override_id": 714, "override_type": "ITEM", "min_permitted": 0, "max_permitted": 1, "override_sku": "1248187953"} ] }, "suspension_info": { "suspend_until": null, "suspend_reason": null, "overrides": [ {"override_id": 641, "override_type": "STORE", "suspend_until": "2025-03-30T00:00:00Z", "suspend_reason": "Is stocked out", "created_at": "2025-03-27T22:01:41.647376Z", "override_sku": ""}, {"override_id": 714, "override_type": "ITEM", "suspend_until": "2025-03-30T00:00:00Z", "suspend_reason": "Is stocked out", "created_at": "2025-03-27T22:01:41.647376Z", "override_sku": "1248187953"} ] }, "schedules_info": { "schedules": [ {"days_of_week": "mon,tue,wed,thu,fri", "time_periods": [{"start_time": "16:00", "end_time": "22:00"}]} ], "overrides": [ {"id": 26, "override_id": 641, "override_sku": "", "override_type": "STORE", "schedules": [{"days_of_week": "mon,tue,wed,thu,fri", "time_periods": [{"start_time": "16:00", "end_time": "23:00"}]}]}, {"id": 27, "override_id": 714, "override_sku": "1248187953", "override_type": "ITEM", "schedules": [{"days_of_week": "mon,tue,wed,thu,fri", "time_periods": [{"start_time": "16:00", "end_time": "20:00"}]}]} ] } } """; RequestBody body = RequestBody.create(json, MediaType.get("application/json")); Request request = new Request.Builder() .url("https://api.dev.rappi.com/restaurants/menu/v1/stores/232/items") .addHeader("Content-Type", "application/json") .addHeader("x-authorization", "Bearer YOUR_TOKEN") .post(body) .build(); try (Response response = client.newCall(request).execute()) { System.out.println(response.body().string()); } } }



Respuesta de Ejemplo "Éxito 200"

Este es un ejemplo de la respuesta "Éxito 200":

{ "message": "Your request has been accepted." }

DELETE Items By Store ID

Usa este endpoint para eliminar múltiples items de una tienda proporcionando sus IDs.

URL del Endpoint

Usa esta URL para realizar una solicitud con este endpoint:

https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{store_id}/items

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

Propiedades del Endpoint

Este recurso tienes las siguiente propiedades:

Formato de respuestaJSON
Requerimientos de autenticaciónToken

Parámetros

Este endpoint tiene los siguientes parámetros:

ParámetroTipoRequeridoDescripción
store_idintIdentificador único de la tienda cuyo menú está siendo solicitado.

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:

DELETE https://api.dev.rappi.com/restaurants/menu/v1/stores/900152558/items

Este es un ejemplo de la llamada:


import okhttp3.*; public class Main { public static void main(String[] args) throws Exception { OkHttpClient client = new OkHttpClient(); String json = "[1,2]"; RequestBody body = RequestBody.create(json, MediaType.get("application/json")); Request request = new Request.Builder() .url("https://api.dev.rappi.com/restaurants/menu/v1/stores/232/items") .delete(body) .addHeader("Content-Type", "application/json") .addHeader("x-authorization", "Bearer YOUR_TOKEN") .build(); try (Response response = client.newCall(request).execute()) { System.out.println(response.body().string()); } } }



Sample Response 'Success 200'

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

{ "message": "Your request has been accepted." }

GET Item By Store ID

Usa este endpoint para obtener los detalles de un artículo específico de una tienda.

URL del Endpoint

Usa esta URL para realizar una solicitud con este endpoint:

https://{NEW_DOMAIN}/restaurants/menu/v1/stores/{store_id}/items/{item_id}

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

Propiedades del Endpoint

Este recurso tienes las siguiente propiedades:

Formato de respuestaJSON
Requerimientos de autenticaciónToken

Parámetros

Este endpoint tiene los siguientes parámetros:

ParámetroTipoRequeridoDescripción
store_iduint64El identificador único de la tienda cuyo menú se está solicitando.
item_iduint64El identificador único del item que se está solicitando.

This parameter is used to specify which store's menu should be retrieved. The store_id should be a valid integer representing a store registered in the system.

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/restaurants/menu/v1/stores/{store_id}/items/{item_id}

Este es un ejemplo de la llamada:


String storeId = "232"; String ItemId = "10" String urlString = "https://api.dev.rappi.com/restaurants/menu/v1/stores/" + storeId + "/items/" + ItemId}; URL url = new URL(urlString); 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"); int responseCode = connection.getResponseCode(); System.out.println("Response Code: " + responseCode); 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()); }



Respuesta de Ejemplo "Éxito 200"

Este es un ejemplo de la respuesta "Éxito 200":

{ "id": 100, "sku": "pastel_de_fresa", "store_id": 232, "last_updated": "2025-03-27T22:01:41.647471Z", "item_type": "ITEM", "title_info": { "title": "Pastel de fresa", "overrides": [ { "override_id": 641, "override_sku": "", "override_type": "STORE", "title": "Pastel de fresa deluxe" }, { "override_id": 714, "override_sku": "1248187953", "override_type": "ITEM", "title": "Acompañamiento: Pastel de fresa" } ] }, "description_info": { "description": "Delicioso pastel de fresa", "overrides": [ { "override_id": 641, "override_type": "STORE", "description": "Delicioso pastel de fresa deluxe", "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "description": "Delicioso acompañamiento: Pastel de fresa", "override_sku": "1248187953" } ] }, "images_info": { "images": [ { "id": 34, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com" } ], "overrides": [ { "override_id": 641, "override_type": "STORE", "images": [ { "id": 43, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com" } ], "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "images": [ { "id": 43544, "path": "my/path/to/my/image.jpg", "index": 1, "host": "https://my.cdn.com" } ], "override_sku": "1248187953" } ] }, "items_info": { "items": [ { "id": 11743, "sku": "1248187964", "index": 1 } ], "overrides": [ { "override_id": 714, "override_type": "ITEM", "items": [ { "id": 11720, "sku": "1248187730", "index": 1 } ], "override_sku": "1248187953" }, { "override_id": 641, "override_type": "STORE", "items": [ { "id": 11716, "sku": "1248187776", "index": 1 } ], "override_sku": "" } ] }, "price_info": { "price": 179, "overrides": [ { "override_id": 641, "override_type": "STORE", "price": 200, "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "price": 0, "override_sku": "1248187953" } ] }, "quantity_info": { "min_permitted": 0, "max_permitted": 5, "modifiers_type": null, "overrides": [ { "override_id": 641, "override_type": "STORE", "min_permitted": 0, "max_permitted": 2, "modifiers_type": null, "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "min_permitted": 0, "max_permitted": 1, "modifiers_type": null, "override_sku": "1248187953" } ] }, "suspension_info": { "suspend_until": null, "suspend_reason": null, "overrides": [ { "override_id": 641, "override_type": "STORE", "suspend_until": "2025-03-30T00:00:00Z", "suspend_reason": "Is stocked out", "created_at": "2025-03-27T22:01:41.647376Z", "override_sku": "" }, { "override_id": 714, "override_type": "ITEM", "suspend_until": "2025-03-30T00:00:00Z", "suspend_reason": "Is stocked out", "created_at": "2025-03-27T22:01:41.647376Z", "override_sku": "1248187953" } ], "is_available": true }, "schedules_info": { "schedules": [ { "days_of_week": "mon,tue,wed,thu,fri", "time_periods": [ { "start_time": "16:00", "end_time": "22:00" } ] } ], "overrides": [ { "id": 26, "override_id": 641, "override_sku": "", "override_type": "STORE", "schedules": [ { "days_of_week": "mon,tue,wed,thu,fri", "time_periods": [ { "start_time": "16:00", "end_time": "23:00" } ] } ] }, { "id": 27, "override_id": 714, "override_sku": "1248187953", "override_type": "ITEM", "schedules": [ { "days_of_week": "mon,tue,wed,thu,fri", "time_periods": [ { "start_time": "16:00", "end_time": "20:00" } ] } ] } ] } }

Descripción de los campos de respuesta

Esta tabla describe los objetos contenidos en el ejemplo de respuesta:

CampoTipoDescripción
idintIdentificador del artículo.
skustringIdentificador de la unidad de mantenimiento de stock (SKU) del artículo. Es obligatorio a menos que se envíe el ID.
store_idintIdentificador de la tienda en la aplicación.
last_updatedstringMarca de tiempo de la última actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
item_typestringTipo de artículo (ITEM o MODIFIER_GROUP).
title_info.titlestringTítulo del artículo.
title_info.overridesarrayLista de modificaciones del título para condiciones específicas.
title_info.overrides[].override_idintIdentificador de la modificación del título.
title_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
title_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
title_info.overrides[].titlestringTítulo modificado.
description_info.descriptionstringDescripción del artículo.
description_info.overridesarrayLista de modificaciones de la descripción para condiciones específicas.
description_info.overrides[].override_idintIdentificador de la modificación de la descripción.
description_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
description_info.overrides[].descriptionstringDescripción modificada.
description_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
images_info.imagesarrayLista de imágenes asociadas con el artículo.
images_info.images[].idintIdentificador de la imagen.
images_info.images[].pathstringRuta donde se encuentra la imagen en el CDN.
images_info.images[].indexintPosición en la que debe mostrarse la imagen.
images_info.images[].hoststringServidor CDN de la imagen.
images_info.overridesarrayLista de modificaciones de imágenes para condiciones específicas.
images_info.overrides[].override_idintIdentificador de la modificación de la imagen.
images_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
images_info.overrides[].imagesarrayLista de imágenes modificadas.
images_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
items_info.itemsarrayLista de artículos relacionados.
items_info.items[].idintIdentificador del artículo relacionado.
items_info.items[].skustringSKU del artículo relacionado. Es obligatorio a menos que se envíe el ID.
items_info.items[].indexintÍndice de orden del artículo relacionado.
items_info.overridesarrayLista de modificaciones de artículos para condiciones específicas.
items_info.overrides[].override_idintIdentificador de la modificación del artículo.
items_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
items_info.overrides[].itemsarrayLista de artículos modificados.
items_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
price_info.pricefloatPrecio del artículo.
price_info.overridesarrayLista de modificaciones de precios para condiciones específicas.
price_info.overrides[].override_idintIdentificador de la modificación del precio.
price_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
price_info.overrides[].pricefloatEl precio que debe aplicarse cuando se cumple la modificación.
price_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
quantity_info.min_permittedintCantidad mínima permitida del artículo o de los elementos dentro del grupo modificador. Obligatorio si el artículo es de tipo MODIFIER_GROUP.
quantity_info.max_permittedintCantidad máxima permitida del artículo o de los elementos dentro del grupo modificador. Obligatorio si el artículo es de tipo MODIFIER_GROUP.
quantity_info.modifiers_typestringTipo de modificador (puede ser nulo).
quantity_info.overridesarrayLista de modificaciones de cantidad para condiciones específicas.
quantity_info.overrides[].override_idintIdentificador de la modificación de cantidad.
quantity_info.overrides[].override_typestringTipo de modificación (STORE o ITEM).
quantity_info.overrides[].min_permittedintCantidad mínima permitida del artículo cuando es de tipo ITEM, o la cantidad mínima permitida dentro del grupo cuando es de tipo MODIFIER_GROUP. Obligatorio si el artículo es de tipo MODIFIER_GROUP.
quantity_info.overrides[].max_permittedintCantidad máxima permitida del artículo cuando es de tipo ITEM, o la cantidad máxima permitida dentro del grupo cuando es de tipo MODIFIER_GROUP. Obligatorio si el artículo es de tipo MODIFIER_GROUP.
quantity_info.overrides[].modifiers_typestringTipo de modificador sobrescrito (puede ser nulo).
quantity_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.
suspension_info.suspend_untilstringFecha en la que el artículo debe activarse. Si es null, entonces está suspendido permanentemente.
suspension_info.suspend_reasonstringRazón por la cual el artículo está suspendido.
suspension_info.is_availableboolEstado de disponibilidad del artículo.
suspension_info.overridesarrayLista de modificaciones de suspensión para condiciones específicas.
schedules_info.schedulesarrayLista de horarios que definen la disponibilidad.
schedules_info.schedules[].days_of_weekstringDías de la semana en los que el horario está activo.
schedules_info.schedules[].time_periodsarrayPeríodos de tiempo dentro del horario.
schedules_info.schedules[].time_periods[].start_timestringHora de inicio en formato HH:MM.
schedules_info.schedules[].time_periods[].end_timestringHora de finalización en formato HH:MM.
schedules_info.overridesarrayLista de modificaciones de horarios para condiciones específicas.
schedules_info.overrides[].override_idintIdentificador de la modificación del horario.
schedules_info.overrides[].override_typestringTipo de modificación (STORE, CATEGORY o ITEM).
schedules_info.overrides[].schedulesarrayLista de horarios modificados.
schedules_info.overrides[].override_skustringEl SKU de la entidad modificada, es obligatorio a menos que se envíe el override_id.