Related Documents
Document Properties
Kbid2504B1
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 - Create new business customer wish list


Note

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

URI

/customers/-/users/-/wishlists

Http Method

POST

Short Description

Creates a new customer wish list by using POST data provided by the client

Query Parameters

none

Example Requests

/customers/-/users/-/wishlists

HTTP Status Codes

201 Created
400 Bad Request
401 Unauthorized

Description

POST-ing to this resource will create a new customer address. The wish list POST data should match the following requirements:

*Title(mandatory)

*Public(optional)

*Preferred (optional)

Cartridge

app_sf_rest, app_sf_rest_smb

Application

SMB 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

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": "aTwKDgBeeUIAAAFCPGc_4HtY",
    "uri": "PrimeTech-PrimeTechBusiness-Site/smb-web-shop/customers/-/users/-/wishlists/aTwKDgBeeUIAAAFCPGc_4HtY"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

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

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>VBwKDgBeQkwAAAFCAHk_4HtV</title>
  <uri>PrimeTech-PrimeTechBusiness-Site/smb-web-shop/customers/-/users/-/wishlists/VBwKDgBeQkwAAAFCAHk_4HtV</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
Support Tickets