Pular para o conteúdo principal

addWishlistItem

Adicione um item à lista de desejos. 🔐 Este método requer autorização (ou um contexto de convidado).

Descrição​

Este método adiciona um único produto à lista de desejos do contexto atual - um usuário autorizado ou um convidado (resolvido via o cabeçalho x-guest-id, veja Modo convidado). Ele retorna uma Promise que resolve para o objeto IWishlistResponse atualizado.

Usuários.addWishlistItem(

body*

);

Esquema de parâmetros​

Esquema

body(obrigatório): IWishlistAddItem
Item a ser adicionado
exemplo:

{ productId: 1 }

body.productId(obrigatório): número
Identificador do produto.
exemplo: 1

Exemplos​

Exemplo mínimo​

const response = await Users.addWishlistItem({ productId: 1 });

Exemplo de resposta​

{
  "items": [
    {
      "productId": 2957,
      "addedAt": "2026-08-14T13:05:07.053Z"
    }
  ],
  "total": 1
}

Esquema de resposta​

Esquema: IWishlistResponse

items: IWishlistItem[]
Itens da lista de desejos.

items.productId: número
Identificador do produto.
exemplo: 1

items.addedAt: string
Data ISO quando o item foi adicionado.
exemplo: "2026-05-30T10:00:00.000Z"

total: número
Número total de itens na lista de desejos.
exemplo: 3