Aller au contenu principal

getProductById

Obtenez un objet produit par son identifiant.

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, isNormalized

);

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"

isNormalized : booléen
Si vrai, l'objet produit sera normalisé

Essayez-le en direct​

Exécutez cette méthode de manière interactive dans le bac à sable JS SDK — connectez votre URL de projet et votre jeton d'application lors de votre première visite, puis ouvrez :

Exemples​

Exemple minimal​

const response = await Products.getProductById(1);

Exemple avec des attributs​

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

Exemple de réponse​

{
  "id": 2954,
  "attributeSetIdentifier": "products",
  "localizeInfos": {
    "title": "Box"
  },
  "statusLocalizeInfos": {
    "title": "Sale"
  },
  "isVisible": true,
  "statusIdentifier": "sale",
  "position": 1,
  "templateIdentifier": null,
  "shortDescTemplateIdentifier": "product_preview",
  "price": 51,
  "additional": {
    "prices": {
      "min": 51,
      "max": 180
    }
  },
  "sku": null,
  "isSync": true,
  "categories": [
    "catalog"
  ],
  "paymentStages": [],
  "rating": {},
  "attributeValues": {
    "product-name": {
      "type": "string",
      "value": "product-name",
      "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",
        "contentType": "image/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",
    "test"
  ],
  "moduleFormConfigs": [
    {
      "id": 12,
      "formIdentifier": "review",
      "moduleIdentifier": "catalog",
      "isGlobal": false,
      "isClosed": false,
      "isModerate": false,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "catalog",
          "isNested": true
        }
      ],
      "formDataCount": 474,
      "ratingCalculation": "average",
      "allowHalfRatings": null,
      "maxRatingScale": null,
      "isAnonymous": null,
      "allowRerating": null,
      "isRating": null,
      "entityFormDataCount": {
        "2954": 474
      },
      "nestedEntityIdentifiers": [
        "catalog"
      ],
      "exceptionIds": []
    }
  ],
  "discountConfig": {}
}

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 null).
exemple : "in_stock"

statusLocalizeInfos : ILocalizeInfo
Nom de statut localisé pour le produit.
exemple : { "title": "Vente" }

attributeSetIdentifier : chaîne | null
Identifiant de l'ensemble d'attributs.
exemple : "set_12345"

position : nombre
Numéro d'article (pour le tri).
exemple : 1

price : nombre | null
La valeur du prix de la page produit prise dans l'index.
exemple : 150.00

additional : objet
Valeur supplémentaire de l'index.
exemple : { prices: { min: 5 max: 150 } }

sku : chaîne | null
SKU du produit (Stock Keeping Unit), peut être null.
exemple : "SKU_12345"

isSync : booléen
Indication de l'indexation de la page.
exemple : vrai

attributeValues : IAttributeValues
Tableau des valeurs d'attributs de l'index, représentées.
exemple :

[
  {
    "id": "color",
    "value": "red"
  }
]

categories : chaîne[]
Catégories de produits.
exemple :

[
  1,
  2,
  3
]

isVisible : booléen
Indicateur de visibilité de la page.
exemple : vrai

moduleFormConfigs : Array<IFormConfig>
Configurations de formulaire de module (facultatif).

rating : IRating
Données d'évaluation.

isPositionLocked : booléen
Indicateur de verrouillage de la position de tri (facultatif).
exemple : faux

relatedIds : nombre[]
Identifiants des pages de produits connexes.
exemple :

[
  12345,
  67890
]

paymentStages : inconnu
Données des étapes de paiement (peut être null).
exemple : null

discountConfig : Record<string, unknown>
Objet de configuration de remise.
exemple :

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"

signedPrice : chaîne
Indication du prix.

productPages : IProductPageRef[]
Tableau de références de pages de produits liant le produit à ses pages.
exemple :

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

productPages.id : nombre
Identifiant unique de l'enregistrement de lien produit-page.
exemple : 16

productPages.pageId : nombre
Identifiant de la page à laquelle le produit est lié.
exemple : 4

productPages.productId : nombre
Identifiant du produit.
exemple : 15

productPages.positionId : nombre
Identifiant de position de tri au sein de la page.
exemple : 244

productPages.categoryPath : chaîne
Chemin de catégorie de la page à laquelle le produit appartient.
exemple : "produits"

blocks : chaîne[]
Tableau d'identifiants de blocs.
exemple :

[
  "block_12345",
  "block_67890"
]