XM

Add Item to Wishlist

Path:

POST https://{baseurl}/api-cart/wishlist/user

Through this API, your customers can easily add a desired item to their Wishlist, for a future purchase. Wishlist helps saves time from searching all the product again, when they are ready to buy.

The item ID can be specified in the request body, and the API returns a userId and the newly added item ID. For an existing Wishlist, along with the userId, all the items in the Wishlist are returned in the response.

Headers

Content-Type : application/json

Authorization: The JWT Authorization toke from the Login API.

x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox"

Parameters

Type: Body

Name: The ID of the item to be added to the Wishlist.

Required: true

Path:

https://{baseURL}/api-cart/wishlist/user

Request Body:

{
"itemId": "1000000013"
}

Response

Response Code: 200

Message: OK

Description: You will see this message when an item is successfully added to the Wishlist.

{
"userId": "5f988dadc3346713da73c1e5",
"items": [
1000000014,
1000000013
]
}

Response Code: 400

Message: Bad Request

Description: You will see this error when the requested item is already in the Wishlist.

{
"code": "ITEM_ALREADY_EXISTS",
"message": "Item already in wishlist."
}

Error Code: 403

Message: Forbidden

Description: You will see this error when the user is not authorized to add items to Wishlist.

{
"code": "UNAUTHORIZED_USER",
"message": "Unauthorized User"
}

Error Code: 500

Message: Internal Server Error

Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).

Change Log

  • June - 2021

  • July - 2020 First updated

‚Äč