Aller au contenu principal

getWishlistSimilar

Obtenez des produits "similaires à la liste de souhaits" à partir de la liste de souhaits du contexte (utilisateur autorisé ou invité).

Description​

Cette méthode renvoie des produits similaires à la liste de souhaits tirée du contexte actuel - un utilisateur autorisé ou un invité (résolu via l'en-tête x-guest-id, voir Mode invité). Elle renvoie une promesse qui se résout en un tableau d'objets IProductsEntity.

Blocks.getWishlistSimilar(

marker*, langCode, signPrice

);

Schéma des paramètres​

Schéma

marker(obligatoire): string
Marqueur de bloc
exemple : "wishlist_similar_block"

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

signPrice: string
Prix de signe

Exemples​

Exemple minimal​

const response = await Blocks.getWishlistSimilar('wishlist_similar_block');

Exemple avec des attributs​

const response = await Blocks.getWishlistSimilar('wishlist_similar_block', 'en_US');

Exemple de réponse​

[
  {
    "id": 1764,
    "localizeInfos": {
      "title": "Product"
    },
    "price": 100,
    "additional": {
      "prices": {
        "min": 0,
        "max": 100
      }
    },
    "isVisible": true,
    "isSync": true,
    "sku": "0-123",
    "attributeValues": {},
    "attributeSetIdentifier": "my-set",
    "statusIdentifier": "in_stock",
    "statusLocalizeInfos": {
      "title": "In stock"
    },
    "position": 1
  }
]

Schéma de réponse​

Schéma : IProductsEntity[]

[]: IProductsEntity
Une entité produit.

[].id: number
L'identifiant unique.
exemple : 12345

[].localizeInfos: ILocalizeInfo
Le nom localisé du produit.
exemple : { "title": "Produit" }

[].price: number | null
Le prix de la page produit tiré de l'index.
exemple : 100

[].sku: string | null
SKU du produit (Stock Keeping Unit), peut être nul.
exemple : "SKU_12345"

[].attributeValues: IAttributeValues
Tableau des valeurs d'attribut de l'index.

[].statusIdentifier: string | null
Identifiant de statut de la page produit (peut être nul).
exemple : "in_stock"

[].isVisible: boolean
Un signe de visibilité de la page.
exemple : true

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