Skip to main content
Version: 8.5.x

Wishlists

Entry Point: /wishlists/{scope}/default

A wishlist is a list that customers build up containing items that they are interested in, or desire to purchase. This applies even to items which are out of stock, which allows a customer to track the item. A wishlist is similar to a cart in that items can be added or removed. Items can also be moved between the wishlist and the cart. Only one wishlist is available per shopper. This default wishlist is automatically available and cannot be deleted.

Read Wishlists​

Returns a list of links to the shopper’s wishlists. Only the default wishlist is currently supported, so responses will contain only one link..

Workflow​

  1. Start with profile
  2. GET the link with rel: wishlists
  3. Render the response

Read Wishlist​

Retrieves a collection of links to wishlist lineitems.

Workflow​

  1. Start with wishlists
  2. GET the link with rel: element
  3. Render the response

Read Default Wishlist​

Retrieves the shopper’s default wishlist.

Workflow​

  1. Start with root
  2. GET the link with rel: defaultwishlist
  3. Render the response

Read Wishlist Line Items​

Retrieves a collection of links to wishlist items and a link to the wishlist.

Workflow​

  1. Start with wishlist
  2. GET the link with rel: lineitems
  3. Render the response

Read Wishlist Line Item​

Retrieves wishlist item details, which include: A link to the list of wishlist items, a link to the wishlist, a link to the item in the items resource, a link to the movetocart form

Workflow​

  1. Start with wishlist-line-items
  2. GET the link with rel: element
  3. Render the response

Response Fields​

Type: wishlists.wishlist-line-item​

NameDescriptionType
configurationThe details of the line item configuration.object

Delete Wishlist Items​

Deletes the items from a shopper’s wishlist.

Workflow​

  1. Start with wishlist-line-items
  2. DELETE wishlist-line-items

Delete Wishlist Item​

Delete item from wishlist.

Workflow​

  1. Start with wishlist-line-item
  2. DELETE wishlist-line-item

Add Item To Default Wishlist​

Adds an item to the default wishlist. After executing the add item to default wishlist action a redirect link is provided to the newly added item on the wishlist.

Workflow​

  1. Start with item
  2. GET the link with rel: addtowishlistform
  3. Fill out the form
  4. POST the form using the link with rel: addtodefaultwishlistaction

Move From Wishlist To Cart​

Moves a line item from the wishlist to the cart. You must specify the quantity in the request body.

Once POSTed, the item deletes from the wishlist and adds to the cart. Then Cortex returns a redirect link to the newly added cart line item. You can also get to the move to cart form by following the link in a wishlist line item. The movetocart form contains an action link to move the item to the cart. Note: The action link will only be present if the wishlist line item is purchasable. If the wishlist line item is not purchasable, the action link will not appear on the form. Only purchasable items can be moved from wishlists into a cart.

The move to cart form may have some blocking advisors. The add to cart form can contain message IDs, such as item.missing.price, item.insufficient.inventory, or item.not.in.store.catalog. For more information, see Structured Messages and Advisors.

Workflow​

  1. Start with wishlist-line-item
  2. GET the link with rel: movetocartform
  3. Fill out the form
  4. POST the form using the link with rel: movetocartaction

Request Fields​

Type: carts.line-item​

NameDescriptionType
quantityThe total number of items in the line item.integer
configurationThe details of the line item configuration.object

Move From Cart To Wishlist​

Moves a line item from the cart to the wishlist.

Once POSTed, Cortex will return a redirect link to the newly added wishlist line item. You can also get to the movetowishlist form by following the link in a cart line item. The movetowishlist form contains an action link to move the item to the wishlist.

Workflow​

  1. Start with line-item
  2. GET the link with rel: movetowishlistform
  3. Fill out the form
  4. POST the form using the link with rel: movetowishlistaction

Read Wishlist Memberships​

Retrieves the list of wishlists that the item has been added to. The list is empty if the item is not in your wishlist.

Workflow​

  1. Start with item
  2. GET the link with rel: wishlistmemberships
  3. Render the response
Last updated on