getProductById
Obtenir un objet produit par id.
Description
Cette méthode récupère un seul objet produit basé sur son identifiant (id) depuis l'API. Elle renvoie une Promesse qui se résout en un objet pour le produit IProductsEntity.
Produits.getProductById(
id*,
langCode
);
Schéma des paramètres
Schéma
id(obligatoire) : nombre
Identifiant du produit
exemple : 12345
langCode : chaîne
Code de langue. Par défaut : "en_US"
exemple : "en_US"
Exemples
Exemple minimal
const response = await Produits.getProductById(1);
Exemple avec des attributs
const response = await Produits.getProductById(1, 'en_US');
Exemple de réponse
{
"id": 2954,
"attributeSetIdentifier": "products",
"localizeInfos": {
"title": "Boîte"
},
"statusLocalizeInfos": {
"title": "Vente"
},
"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": "nom-du-produit",
"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": []
}
Schéma de réponse
Schéma : IProductsEntity
id : nombre
L'identifiant unique.
exemple : 12345
localizeInfos : ILocalizeInfo
Le nom des produits, en tenant compte de la localisation.
exemple :
statusIdentifier : chaîne | null
Identifiants de statut de la page produit (peut être nul).
exemple : "in_stock"
statusLocalizeInfos : tout
Description JSON de l'objet statut de l'élément, en tenant compte de la langue.
exemple :
attributeSetIdentifier : chaîne | null
Identifiant de l'ensemble d'attributs.
exemple : "set_12345"
position : nombre
Numéro de l'élément (pour le tri).
exemple : 1
templateIdentifier : chaîne | null
Identifiant utilisateur du modèle lié.
exemple : "template_12345"
shortDescTemplateIdentifier : chaîne | null
Identifiant utilisateur du modèle lié pour une courte description.
exemple : "short_desc_template_12345"
price : nombre
La valeur du prix de la page produit prise de l'index.
exemple : 150
additional : objet
Valeur supplémentaire de l'index.
exemple :
{
"en": "En Stock",
"de": "Auf Lager"
}
sku : chaîne | null
SKU du produit (Stock Keeping Unit), peut être nul.
exemple : "SKU_12345"
isSync : booléen
Indication de l'indexation de la page.
exemple : true
attributeValues : AttributeType
Tableau des valeurs d'attributs de l'index, représenté.
exemple :
[
{
"id": "color",
"value": "red"
}
]
categories : chaîne[]
Catégories de produits.
exemple :
[
1,
2,
3
]
isVisible : booléen
Un signe de visibilité de la page.
exemple : true
productPages : tout
Tableau de pages de produits ou un seul objet de page produit.
exemple : []
blocks : chaîne[]
Tableau d'identifiants de blocs.
exemple :
[
"block_12345",
"block_67890"
]
isPositionLocked : booléen
Indicateur de verrouillage de la position de tri (optionnel).
exemple : false
relatedIds : nombre[]
Identifiants des pages de produits connexes.
exemple :
[
12345,
67890
]