Share Customer Wishlist: eventShareWishlist

The Share Customer Wishlist event API captures information when a customer shares their wishlist with others. It records the customer’s information and the details of the products included in the wishlist.

API Endpoint and Method

URL

https://sandbox.algonomy.com/callback/rest/events/{APP_API_KEY}/eventShareWishlist
			

Example URL

https://sandbox.algonomy.com/callback/rest/events/ABCDILOBZCGHVLZTCNTGJMYGQEARWVZVCUPYVUGNCZPJRSUDAR/eventShareWishlist
			

HTTP Method

POST

Parameters

Parameter

Type Required or Optional

Description

sharingCustomer

String

Required

Customer information of the person sharing the wishlist.

Example: {"customerCode": "100", "email":"sample@email.com", "mobile":"1234567890", "uuid":"ABDKLHJJKGHJFGGH785764564544ghcfgdgfdfd"}

customerCode

String

Conditional

Unique code of the customer sharing the wishlist.

Example: "100"

email

String

Conditional

Email address of the customer sharing the wishlist.

Example: "sample@email.com"

mobile

String

Conditional

Mobile number of the customer sharing the wishlist.

Example: "1234567890"

uuid

String

Required

Unique identifier (UUID) of the customer sharing the wishlist.

Example: "ABDKLHJJKGHJFGGH78576"

Wish List Product Parameters

Parameter

Type Required or Optional

Description

productId

String

Required

Unique identifier of the product in the wishlist.

Example: "814"

quantity

Integer

Optional

Quantity of the product in the wishlist.

Example: 2

productBasePrice

Float

Optional

Base price of the product.

Example: "210.0000"

tax

Float Optional

Tax applied to the product.

Example: "17.3300"

discount

Float Optional

Discount applied to the product.

Example: "0.0000"

couponCode

String

Optional

Coupon code applied to the product.

Example: null

Request Body Schema

{
"eventData": {
"eventType":"eventShareWishlist",
"sharingCustomer": {
"customerCode":"String",
"email":"String",
"mobile":"String",
"uuid":"String"
},
"wishlistProducts": [
{
"productId":"String",
"quantity":"Integer",
"productBasePrice":"Float",
"tax":"Float",
"discount":"Float",
"couponCode":"String"
}
]
}
}
			

Example Request

{
"eventData": {
"eventType":"eventShareWishlist",
"sharingCustomer": {
"customerCode":"100",
"email":"sample@email.com",
"mobile":"1234567890",
"uuid":"ABDKLHJJKGHJFGGH78576"
},
"wishlistProducts": [
{
"productId":"814",
"quantity":2,
"productBasePrice":"210.0000",
"tax":"17.3300",
"discount":"0.0000",
"couponCode":null
}
]
}
}
			

Example Response

{
"status": "success",
"message": "Wishlist shared successfully."
}
			

HTTP Response Codes

Response Code

Description

202 Accepted The request has been received and validated, but processing is asynchronous and not yet complete.