Saltar al contenido principal

getProductsByIds

Obteniendo múltiples productos por sus ids

Products.getProductsByIds(ids, langCode, userQuery)

const value = await Products.getProductsByIds('1, 5, 8', 'en_US')
Esquema

ids:* cadena
Identificadores de la página del producto para los cuales encontrar relaciones
ejemplo: 1,3,5,15

langCode: cadena
Parámetro del código de idioma. Por defecto "en_US"
ejemplo: en_US

userQuery: IProductsQuery
Conjunto de parámetros de consulta opcionales
ejemplo: []

userQuery.offset: número
Parámetro opcional para paginación, por defecto es 0
ejemplo: 0

userQuery.limit: número
Parámetro opcional para paginación, por defecto es 30
ejemplo: 30

userQuery.sortOrder: cadena
Orden de clasificación opcional DESC | ASC
ejemplo: DESC

userQuery.sortKey: cadena
Campo opcional para ordenar (id, título, fecha, precio, posición, estado)
ejemplo: id

Este método recupera objetos de productos basados en sus identificadores (ids) de la API. Devuelve una Promesa que se resuelve en objetos IProductsEntity para el producto.

Ejemplo de retorno:

[
{
"id": 1764,
"localizeInfos": {
"en_US": {
"title": "Product"
}
},
"isVisible": true,
"isSync": true,
"price": 0,
"additional": {
"prices": {
"min": 0,
"max": 100
}
},
"blocks": [
null
],
"sku": "0-123",
"productPages": [
{
"id": 8997,
"pageId": 1176,
"productId": 8872
}
],
"statusLocalizeInfos": {
"en_US": {
"title": "Product"
}
},
"templateIdentifier": "my-template",
"shortDescTemplateIdentifier": "my-template-short",
"attributeValues": {
"en_US": {
"marker": {
"value": "",
"type": "string",
"position": 1,
"isProductPreview": false,
"isIcon": false,
"attributeFields": {
"marker": {
"type": "string",
"value": "test"
}
}
}
}
},
"attributeSetIdentifier": "my-set",
"statusIdentifier": "my-status",
"position": 1
}
]
Esquema

id: número
identificador del objeto
ejemplo: 1764

localizeInfos: Record<string, any>
descripción json del objeto de datos de la página principal teniendo en cuenta el idioma "en_US" (por ejemplo)
ejemplo:

{
"en_US": {
"title": "Catalog",
"plainContent": "Contenido para el catálogo",
"htmlContent": "<b>Contenido para el catálogo</b>",
"menuTitle": "Catálogo"
}
}

isVisible: booleano
bandera de visibilidad de la página
ejemplo: true

isSync: booleano
indicador de indexación de la página (true o false)
ejemplo: false

price: número
valor del precio de la página del producto tomado del índice
ejemplo: 0

additional: Record<string, any>
valor adicional del índice
ejemplo:

{
"prices": {
"min": 0,
"max": 100
}
}

blocks: array
bloques de producto
ejemplo:

["product_block"]

sku: cadena
valor SKU del producto tomado del índice
ejemplo: 1

productPages: array
objetos ProductPageEntity vinculados a la página del producto (opcional)
ejemplo:

[
{
"id": 8997,
"pageId": 1176,
"productId": 8872
}
]

statusLocalizeInfos: CommonLocalizeInfos
descripción json del objeto de estado del ítem, teniendo en cuenta el idioma
ejemplo:

{ "title": "Product" }

templateIdentifier: cadena
identificador personalizado de la plantilla asociada
ejemplo: my-template

shortDescTemplateIdentifier cadena
identificador personalizado de la plantilla asociada para la descripción corta
ejemplo: my-template-short

attributeValues: Record<string, string>
Array de valores de atributos del índice (presentados como un par de identificador de atributo personalizado: valor de atributo)
ejemplo:

{
"en_US": {
"marker": {
"value": "",
"type": "string"
}
}
}

attributeSetIdentifier: cadena
identificador textual del conjunto de atributos utilizado
ejemplo: 'my-set'

statusIdentifier: cadena
identificador textual del estado del producto
ejemplo: 'my-status'

position: número
número de posición (para ordenación)
ejemplo: 1