getProductsByIds
Obteniendo múltiples productos por sus identificadores.
Productos?.getProductsByIds( ids?, langCode?, userQuery? );
const value = await Products.getProductsByIds('1, 5, 8', 'en_US')
Ejemplo mínimo
Esquema
ids: string
Identificadores de página de producto para los cuales encontrar relaciones
ejemplo: "12345,67890"
langCode: string
Código de idioma. Por defecto "en_US"
userQuery: IProductsQuery
Parámetros de consulta opcionales
ejemplo:
{
"offset": 0,
"limit": 30,
"sortOrder": "DESC",
"sortKey": "id"
}
offset(required): number
Parámetro para paginación. Por defecto: 0.
limit(required): number
Parámetro para paginación. Por defecto: 30.
sortOrder(required): string
Orden de clasificación "DESC" | "ASC". Por defecto: "DESC".
sortKey(required): string
Campo para ordenar (por defecto - null). Valores posibles: "id", "position", "title", "date", "price". Por defecto: null.
templateMarker: string | null
Marcador de plantilla de página de producto, por defecto null.
ejemplo: "template_12345"
statusMarker: string | null
Marcador de estado de página de producto, por defecto null.
ejemplo: "in_stock"
conditionValue: string | null
El valor que se está buscando, por defecto null.
ejemplo: "new"
attributeMarker: string | null
El identificador de texto del atributo indexado por el cual se filtran los valores, por defecto null.
ejemplo: "color"
conditionMarker: string | null
Marcador de la condición de filtro por la cual se filtran los valores, por defecto null.
ejemplo: "equals"
Este método recupera objetos de productos basados en sus identificadores (ids) desde la API. Devuelve una Promesa que se resuelve en objetos IProductsEntity para el producto.
Ejemplo de respuesta
[
{
"id": 2954,
"localizeInfos": {
"title": "Caja"
},
"statusIdentifier": "venta",
"statusLocalizeInfos": {
"title": "Venta"
},
"attributeSetIdentifier": "productos",
"position": 2,
"templateIdentifier": null,
"shortDescTemplateIdentifier": "product_preview",
"price": 50,
"additional": {
"prices": {
"min": 50,
"max": 150
}
},
"sku": null,
"isSync": true,
"attributeValues": {
"product-name": {
"type": "string",
"value": "nombre-del-producto",
"isIcon": false,
"position": 0,
"additionalFields": [],
"isProductPreview": false
},
"price": {
"type": "integer",
"value": 50,
"isIcon": false,
"position": 1,
"additionalFields": [],
"isProductPreview": false
},
"currency_products": {
"type": "string",
"value": "usd",
"isIcon": false,
"position": 2,
"additionalFields": [],
"isProductPreview": false
},
"img": {
"type": "image",
"value": [],
"isIcon": false,
"position": 3,
"additionalFields": [],
"isProductPreview": false
}
},
"categories": [
"catálogo"
],
"isVisible": true,
"productPages": [
{
"id": 2847,
"pageId": 10,
"productId": 2954,
"positionId": 3190,
"categoryPath": "catálogo"
}
],
"blocks": [
"bloque_producto",
"bloque_producto"
]
},
{
"id": 2955,
"localizeInfos": {
"title": "Producto"
},
"statusIdentifier": "venta",
"statusLocalizeInfos": {
"title": "Venta"
},
"attributeSetIdentifier": null,
"position": 1,
"templateIdentifier": null,
"shortDescTemplateIdentifier": null,
"price": null,
"additional": {
"prices": {
"min": 50,
"max": 150
}
},
"sku": null,
"isSync": false,
"attributeValues": {},
"categories": [
"catálogo"
],
"isVisible": true,
"productPages": [
{
"id": 2848,
"pageId": 10,
"productId": 2955,
"positionId": 3191,
"categoryPath": "catálogo"
}
],
"blocks": [
"bloque_producto",
"bloque_producto"
]
}
]
Esquema
id: number
El identificador único.
ejemplo: 12345
localizeInfos: ILocalizeInfo
El nombre de los productos, teniendo en cuenta la localización.
statusIdentifier: string | null
Identificadores de estado de página de producto (puede ser null).
ejemplo: "in_stock"
statusLocalizeInfos: any
Descripción JSON del objeto de estado del ítem, teniendo en cuenta el idioma.
attributeSetIdentifier: string | null
Conjunto de identificadores de atributos.
ejemplo: "set_12345"
position: number
Número del ítem (para ordenar).
ejemplo: 1
templateIdentifier: string | null
Identificador de usuario de la plantilla vinculada.
ejemplo: "template_12345"
shortDescTemplateIdentifier: string | null
Identificador de usuario de la plantilla vinculada para una descripción corta.
ejemplo: "short_desc_template_12345"
price: number
El valor del precio de la página de producto tomado del índice.
ejemplo: 150
additional: object
Valor adicional del índice.
sku: string | null
SKU del producto (Unidad de Mantenimiento de Stock), puede ser null.
ejemplo: "SKU_12345"
isSync: boolean
Indicación de indexación de página.
ejemplo: true
attributeValues: AttributeType
Array de valores de atributos del índice, representados.
ejemplo:
[
{
"id": "color",
"value": "rojo"
}
]
categories: string[]
Categorías de productos.
ejemplo:
[
1,
2,
3
]
isVisible: boolean
Un signo de visibilidad de la página.
ejemplo: true
productPages: any[]
Array de páginas de producto o un solo objeto de página de producto.
blocks: string[]
Array de identificadores de bloques.
isPositionLocked: boolean
Indicador de bloqueo de posición de ordenación (opcional).
ejemplo: false
relatedIds: number[]
Ids de páginas de productos relacionadas.
ejemplo:
[
12345,
67890
]