getProductById
Obtiene un objeto de producto por id.
Descripción
Este método recupera un único objeto de producto basado en su identificador (id) de la API. Devuelve una Promesa que se resuelve en un objeto para el producto IProductsEntity.
Productos.getProductById(
id*,
langCode
);
Esquema de parámetros
Esquema
id(requerido): número
Id del producto
ejemplo: 12345
langCode: cadena
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"
Ejemplos
Ejemplo mínimo
const response = await Productos.getProductById(1);
Ejemplo con atributos
const response = await Productos.getProductById(1, 'en_US');
Ejemplo de respuesta
{
"id": 2954,
"attributeSetIdentifier": "products",
"localizeInfos": {
"title": "Caja"
},
"statusLocalizeInfos": {
"title": "Venta"
},
"isVisible": true,
"statusIdentifier": "sale",
"position": 1,
"templateIdentifier": null,
"shortDescTemplateIdentifier": "product_preview",
"price": 51,
"additional": {
"prices": {
"min": 51,
"max": 150
}
},
"sku": null,
"isSync": true,
"categories": [
"catalog"
],
"attributeValues": {
"product-name": {
"type": "string",
"value": "nombre-del-producto",
"isIcon": false,
"position": 0,
"additionalFields": [],
"isProductPreview": false
},
"price": {
"type": "integer",
"value": 51,
"isIcon": false,
"position": 1,
"additionalFields": [],
"isProductPreview": false
},
"currency_products": {
"type": "string",
"value": "usd",
"isIcon": false,
"position": 2,
"additionalFields": [],
"isProductPreview": false
},
"img": {
"type": "image",
"value": {
"size": 241636,
"filename": "files/project/product/2954/image/7e0a6a70-a23d-410f-8b6a-f8b4f7483244.png",
"downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/7e0a6a70-a23d-410f-8b6a-f8b4f7483244.png"
},
"isIcon": false,
"position": 3,
"additionalFields": [],
"isProductPreview": false
}
},
"productPages": [
{
"id": 2847,
"pageId": 10,
"productId": 2954,
"positionId": 3190,
"categoryPath": "catalog"
}
],
"blocks": [
"product_block"
],
"moduleFormConfigs": []
}
Esquema de respuesta
Esquema: IProductsEntity
id: número
El identificador único.
ejemplo: 12345
localizeInfos: ILocalizeInfo
El nombre de los productos, teniendo en cuenta la localización.
ejemplo:
statusIdentifier: cadena | null
Identificadores de estado de la página del producto (puede ser nulo).
ejemplo: "in_stock"
statusLocalizeInfos: cualquier
Descripción JSON del objeto de estado del artículo, teniendo en cuenta el idioma.
ejemplo:
attributeSetIdentifier: cadena | null
Id del conjunto de atributos.
ejemplo: "set_12345"
position: número
Número del artículo (para ordenar).
ejemplo: 1
templateIdentifier: cadena | null
Id de usuario de la plantilla vinculada.
ejemplo: "template_12345"
shortDescTemplateIdentifier: cadena | null
Id de usuario de la plantilla vinculada para una descripción corta.
ejemplo: "short_desc_template_12345"
price: número
El valor del precio de la página del producto tomado del índice.
ejemplo: 150
additional: objeto
Valor adicional del índice.
ejemplo:
{
"en": "En Stock",
"de": "Auf Lager"
}
sku: cadena | null
SKU del producto (Unidad de Mantenimiento de Stock), puede ser nulo.
ejemplo: "SKU_12345"
isSync: booleano
Indicación de indexación de la página.
ejemplo: true
attributeValues: AttributeType
Array de valores de atributos del índice, representados.
ejemplo:
[
{
"id": "color",
"value": "rojo"
}
]
categories: cadena[]
Categorías de productos.
ejemplo:
[
1,
2,
3
]
isVisible: booleano
Un signo de visibilidad de la página.
ejemplo: true
productPages: cualquier
Array de páginas de productos o un solo objeto de página de producto.
ejemplo: []
blocks: cadena[]
Array de identificadores de bloques.
ejemplo:
[
"block_12345",
"block_67890"
]
isPositionLocked: booleano
Indicador de bloqueo de posición de orden (opcional).
ejemplo: false
relatedIds: número[]
Ids de páginas de productos relacionadas.
ejemplo:
[
12345,
67890
]