getProductById

Obtenir un objet produit par id

Products.getProductById(id, langCode)

const value = await Products.getProductById(1)

Schéma

id:* Identifiant du produit

• Identifiant du produit*
  exemple : 1
  

langCode:
Paramètre de code de langue. Par défaut "en_US"
exemple : en_US

Cette méthode récupère un seul objet produit basé sur son identifiant (id) depuis l'API. Elle retourne une promesse qui se résout en un objet pour le produit.

Exemple de retour :

{
  "id": 3,
  "localizeInfos": {
    "title": "Produit"
  },
  "statusIdentifier": null,
  "statusLocalizeInfos": {},
  "attributeSetIdentifier": "products",
  "position": 1,
  "templateIdentifier": null,
  "shortDescTemplateIdentifier": null,
  "price": 120,
  "additional": {
    "prices": {
      "min": 120,
      "max": 150
    }
  },
  "sku": null,
  "isSync": true,
  "attributeValues": {
    "price": {
      "type": "integer",
      "value": "120",
      "position": 1,
      "isProductPreview": false
    },
    "product-name": {
      "type": "string",
      "value": "Prod",
      "position": 0,
      "isProductPreview": false
    },
    "currency_products": {
      "type": "string",
      "value": "$",
      "position": 2,
      "isProductPreview": false
    }
  },
  "isVisible": true,
  "productPages": {
    "id": 3,
    "pageId": 2,
    "productId": 3,
    "positionId": 215
  },
  "blocks": [
    "product_block",
    "another"
  ]
}

Schéma

id: nombre
identifiant de l'objet
exemple : 1764

additional: Record<string, any>
valeur supplémentaire de l'index
exemple :

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

statusLocalizeInfos: CommonLocalizeInfos
description json de l'objet statut, prenant en compte la langue
exemple :

{ "title": "Produit" }

localizeInfos: Record<string, any>
description json des données de la page principale prenant en compte la langue "en_US" (par exemple)
exemple :

{
  "en_US": {
    "title": "Catalogue",
    "plainContent": "Contenu pour le catalogue",
    "htmlContent": "<b>Contenu pour le catalogue</b>",
    "menuTitle": "Catalogue"
  }
}

isVisible: booléen
Indicateur de visibilité de la page
exemple : true

position: nombre
numéro de position (pour le tri)
exemple : 192

templateIdentifier: chaîne
identifiant personnalisé du modèle associé
exemple : my-template

attributeSetId: nombre
identifiant de l'ensemble d'attributs
exemple : 7

blocks: tableau
blocs de produit
exemple : ['product_block']

isSync: booléen
indicateur d'indexation de la page (true ou false)
exemple : false

attributeValues: Record<string, string>
Tableau des valeurs d'attributs de l'index (présenté sous forme de paire d'identifiant d'attribut personnalisé : valeur d'attribut)
exemple :

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

statusId: nombre
identifiants de statut de la page produit (peut être nul)
exemple : 1

sku: chaîne
valeur SKU du produit prise de l'index
exemple : 1

relatedIds: tableau
identifiants des pages de produits associés
exemple :

[ 1, 2, 3 ]

price: nombre
valeur du prix de la page produit prise de l'index
exemple : 0

templateIdentifier chaîne
identifiant personnalisé du modèle associé
exemple : my-template

shortDescTemplateIdentifier chaîne
identifiant personnalisé du modèle associé pour la description courte
exemple : my-template-short