getRelatedProductsById

Rechercher tous les objets de produits associés par identifiant de page

Products.getRelatedProductsById(id, langCode, userQuery)

const value = await Products.getRelatedProductsById(1)

Schéma

id:* number
Identifiant de la page produit pour laquelle trouver la relation
exemple :

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

userQuery: IProductsQuery
Paramètres de requête optionnels
exemple : []

userQuery.offset: number
Paramètre optionnel pour la pagination, par défaut 0
exemple : 0

userQuery.limit: number
Paramètre optionnel pour la pagination, par défaut 30
exemple : 30

userQuery.sortOrder: string
Ordre de tri optionnel DESC | ASC
exemple : DESC

userQuery.sortKey: string
Champ optionnel pour trier (id, title, date, price, position, status)
exemple : id

Cette méthode récupère tous les objets de page produit associés pour un produit spécifique basé sur son identifiant (id) depuis l'API. Elle accepte un paramètre optionnel userQuery pour des paramètres de requête supplémentaires tels que offset, limit, sortOrder et sortKey. Elle retourne une promesse qui se résout en un tableau d'objets.

Exemple de retour :

{
  "total": 100,
  "items": [
    {
      "id": 2,
      "localizeInfos": {
        "title": "Boîte"
      },
      "statusIdentifier": "vendu",
      "statusLocalizeInfos": {
        "title": "Vendu"
      },
      "attributeSetIdentifier": "produits",
      "position": 3,
      "templateIdentifier": null,
      "isPositionLocked": false,
      "shortDescTemplateIdentifier": null,
      "price": 148,
      "additional": {
        "prices": {
          "min": 120,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "price": {
          "type": "integer",
          "value": 148,
          "position": 1,
          "isProductPreview": false
        },
        "product-name": {
          "type": "string",
          "value": "Texte de la boîte",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "$",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true,
      "isPositionLocked": false
    }

  ]
}

Schéma

total: number
nombre total d'enregistrements trouvés
exemple : 100

id: number
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 d'état de l'élément, en tenant compte de la langue
exemple :

{ "title": "Produit" }

localizeInfos: Record<string, any>
description json de l'objet de données de la page principale en tenant compte de 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: boolean
Indicateur de visibilité de la page
exemple : true

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

templateIdentifier: string
identifiant personnalisé du modèle associé
exemple : my-template

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

blocks: array
blocs de produits
exemple : ['product_block']

isSync: boolean
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: number
identifiants d'état de la page produit (peut être nul)
exemple : 1

sku: string
valeur SKU du produit prise de l'index
exemple : 1

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

[ 1, 2, 3 ]

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

templateIdentifier string
identifiant personnalisé du modèle associé
exemple : my-template

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