Saltar al contenido principal

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.

Products.getProductById(

id, langCode

);

Esquema de parámetros

Esquema

id: number
Id del producto
ejemplo: 12345

langCode: string
Código de idioma. Por defecto: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

const response = await Products.getProductById(1);

Ejemplo con atributos

const response = await Products.getProductById(1, 'en_US');

Ejemplo de respuesta

{
"id": 2954,
"localizeInfos": {
"title": "Caja"
},
"statusIdentifier": "venta",
"statusLocalizeInfos": {
"title": "Venta"
},
"attributeSetIdentifier": "productos",
"position": 1,
"templateIdentifier": null,
"shortDescTemplateIdentifier": "product_preview",
"price": 51,
"additional": {
"prices": {
"min": 51,
"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": 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": [],
"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"
],
"moduleFormConfigs": []
}

Esquema de respuesta

Esquema: IProductsEntity

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 la página del producto (puede ser nulo).
ejemplo: "en_stock"

statusLocalizeInfos: any
Descripción JSON del objeto de estado del ítem, teniendo en cuenta el idioma.

attributeSetIdentifier: string | null
Id del conjunto de atributos.
ejemplo: "set_12345"

position: number
Número del ítem (para ordenar).
ejemplo: 1

templateIdentifier: string | null
Id de usuario de la plantilla vinculada.
ejemplo: "template_12345"

shortDescTemplateIdentifier: string | null
Id 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 del producto tomado del índice.
ejemplo: 150

additional: object
Valor adicional del índice.
ejemplo:

{
"en": "En Stock",
"de": "Auf Lager"
}

sku: string | null
SKU del producto (Unidad de Mantenimiento de Stock), puede ser nulo.
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 productos o un único objeto de página de producto.

blocks: string[]
Array de identificadores de bloques.
ejemplo:

[
"block_12345",
"block_67890"
]

isPositionLocked: boolean
Indicador de bloqueo de posición de orden (opcional).
ejemplo: false

relatedIds: number[]
Ids de páginas de productos relacionadas.
ejemplo:

[
12345,
67890
]