Related Documents
Document Properties
Kbid250H29
Last Modified23-Jun-2020
Added to KB15-Aug-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Update private customer wish list


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/customers/-/wishlists/<wishlist-id>

Http Method

PUT

Short Description

Updates a customer wish list with wish list data provided from the client

Query Parameters

none

Example Requests

/customers/-/wishlists/<wishlist-id>

HTTP Status Codes

200 OK
400 Bad Request

Possible values for header ‘error-key’:

    • customer.wishlist.missing_fields.error

401 Unauthorized
404 Not found

Description

Updates a customer wish list with data provided by the client. The wish list should complete the following requirements:

*Title (mandatory)
*Public (optional)
*Preferred (optional)

Cartridge

app_sf_rest, app_sf_rest_b2c

Application

B2C Web Shop

Product Version

7.4

Product To Version


Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource
com.intershop.sellside.rest.common.capi.resourceobject.WishListRO

Request Example

{
	"title" : "UpdatedWishlist",
	"public" : "true",	
	"preferred" : "false"
}

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource
com.intershop.sellside.rest.common.capi.resourceobject.WishListRO

Response Example

{
	"type": "WishList",
    "public": true,
    "preferred": false,
    "itemsCount": 0,
    "title": "Updated Favourite Wishlist"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource
com.intershop.sellside.rest.common.capi.resourceobject.WishListRO

XML Request Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<WishList>
    <title>Updated Favourite Wishlist</title>
    <public>true</public>
    <preferred>true</preferred>
</WishList>

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource
com.intershop.sellside.rest.common.capi.resourceobject.WishListRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<WishList type="WishList">
  <itemsCount>0</itemsCount>
  <preferred>false</preferred>
  <public>true</public>
  <title>Updated Favourite Wishlist</title>
</WishList>

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets