Skip to content

WishlistChangeEvent ​

Type: schema

Description ​

Emitted when a product is added to or removed from the shopper's wishlist.

TypeScript Definition ​

typescript
WishlistChangeEvent: {{
            /**
             * @description discriminator enum property added by openapi-typescript
             * @enum {string}
             */
            event: "Product Added to Wishlist" | "Product Removed from Wishlist"
}

OpenAPI Schema ​

json
{
  "title": "WishlistChangeEvent",
  "description": "Emitted when a product is added to or removed from the shopper's wishlist.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/WishlistChangeEvent",
    "description": "API reference for the WishlistChangeEvent schema"
  },
  "required": [
    "event",
    "event_id",
    "product_id",
    "variant_id"
  ],
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "Product Added to Wishlist",
        "Product Removed from Wishlist"
      ]
    },
    "event_id": {
      "description": "Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe.",
      "type": "string",
      "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$"
    },
    "product_id": {
      "description": "The product added to or removed from the wishlist.",
      "type": "string"
    },
    "variant_id": {
      "description": "The product variant, or `null` when the product has no variants.",
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: