setWishlist

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

Description

Cette méthode remplace l'intégralité de la liste de souhaits du contexte actuel - un utilisateur autorisé ou un invité (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*

);

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.
exemple:

[{ productId: 1 }]

items.productId(obligatoire): 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"

Exemples

Exemple minimal

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

Exemple de réponse

{
  "items": [
    {
      "productId": 2957,
      "addedAt": "2026-06-07T14:43:33.527Z"
    }
  ],
  "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

---