Aller au contenu principal

setWishlist

Remplace la liste de souhaits de l'utilisateur actuel ou du visiteur. 🔐 Cette méthode nécessite l'autorisation (ou un contexte de visiteur).

Description​

Cette méthode remplace l'intégralité de la liste de souhaits du contexte actuel - un utilisateur autorisé ou un visiteur (résolu via l'en-tête x-guest-id, voir Mode invité) - par les éléments fournis. Elle renvoie une promesse qui se résout en un objet IWishlistResponse mis à jour.

Users.setWishlist(

body*, body.items*

);

Schéma des paramètres​

Schéma

body(obligatoire): IWishlistSet
Nouveaux contenus de la liste de souhaits. Exemple : { items: [{ productId: 1 }] }

body.items(obligatoire): IWishlistItem[]
Nouveaux éléments de la liste de souhaits.

body.items.productId(obligatoire): number
Identifiant du produit.
exemple : 1

Exemples​

Exemple minimal​

const response = await Users.setWishlist({
  items: [{ productId: 1 }],
});

Exemple de réponse​

{
  "items": [
    {
      "productId": 1,
      "addedAt": "2026-05-30T10:00:00.000Z"
    }
  ],
  "total": 1
}

Schéma de réponse​

Schéma : IWishlistResponse

items: IWishlistItem[]
Éléments de la liste de souhaits.

items.productId: number
Identifiant du produit.
exemple : 1

items.addedAt: string
Date ISO à laquelle l'élément a été ajouté.
exemple : "2026-05-30T10:00:00.000Z"

total: number
Nombre total d'éléments dans la liste de souhaits.
exemple : 3