Related Documents
Document Properties
Kbid
R25040
Last Modified
23-Jun-2020
Added to KB
15-Aug-2013
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Create new private customer wish list


Note

Starting with Intershop 7.10 our REST API is provided in the Open API 3.0 format, see Reference - Intershop Commerce Management REST API 7.10.

URI

/customers/-/wishlists

Http Method

POST

Short Description

Creates a new customer wish list

Query Parameters

none

Example Requests

/customers/-/wishlists

HTTP Status Codes

201 Created
400 Bad Request
401 Unauthorized

Description

Create a new customer wish list. The wish list data should match 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.CustomerWishlistListResource
com.intershop.sellside.rest.common.capi.resourceobject.WishListRO

Request Example

{
  "title":"Wishlist",
  "public":"true",
  "preferred" :"true"
}

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistListResource
com.intershop.component.rest.capi.resourceobject.LinkRO

Response Example

{
"type": "Link",
"title": "DXcKDgBeU8kAAAFCGRtEdHDt",
"uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/customers/-/wishlists/DXcKDgBeU8kAAAFCGRtEdHDt"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

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

XML Request Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<WishList>
    <title>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.CustomerWishlistListResource
com.intershop.component.rest.capi.resourceobject.LinkRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Link type="Link">
<title>PPMKDgBeddUAAAFC05BEdHD0</title>
<uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/customers/-/wishlists/PPMKDgBeddUAAAFC05BEdHD0</uri>
</Link>

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
Tickets