Related Documents
Document Properties
Kbid250Z59
Last Modified23-Jun-2020
Added to KB23-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 - Share wish list of business customer's user with given recipient


Note

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

URI

/customers/-/users/-/wishlists/<wishlistID>/share

Http Method

POST

Short Description

Shares a wish list of business customer's user with given recipient

Query Parameters

none

Example Requests

/customers/-/users/-/wishlists/<wishlistID>/share

HTTP Status Codes

201 Created
400 Bad Request

Possible values for error-key:

    • account.wishlist.invalid_fields.error

401 Unauthorized
404 Not found

Description

Shares a wish list with a friend, e.g., a secure deep link is provided to the recipient's e-mail which could be used to view the wish list, even if it is private.

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.resourceobject.customer.wishlist.share.WishlistSharingRO
com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource

Request Example

{
  "message": "Hey, this is my wishlist!",
  "sender": "John Doe",
  "recipients": "alice@web.de"
}
 
or
 
{
  "message": "Hey, this is my wishlist!",
  "sender": "John Doe",
  "recipients": "alice@web.de,alexandra@web.de"
}

Response Data Format

Response related java object

n/a

Response Example

n/a

XML

XML Request Data Format

XML Request Java Objects

com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.share.WishlistSharingRO
com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource

XML Request Example

<WishlistSharing>
    <message>Hey, this is my wishlist!</message>
    <recipients>alice@web.de</recipient>
    <sender>John Doe</sender>
</WishlistSharing>
 
or
 
<WishlistSharing>
    <message>Hey, this is my wishlist!</message>
    <recipients>alice@web.de,alexandra@web.de</recipient>
    <sender>John Doe</sender>
</WishlistSharing>

XML Response Data Format

XML Response Java Objects

n/a

XML Response Example

n/a

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