Related Documents
Document Properties
Kbid2Z5066
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 - Public wish lists


Note

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

URI

/wishlists/

Http Method

GET

Short Description

Returns a list of links to public wish lists

Query Parameters

firstname - optional filtering by users' first name
lastname - optional filtering by users' first name
email - - optional filtering by user's e-mail

Example Requests

/wishlists?firstname=<firstName>&lastname=<lastName>&email=<email>

HTTP Status Codes

200 OK

Description

Returns a list of links to public wish lists created by the private customers or users of a business customers.

Optionally, the results could be narrowed down with search parameters - first name, last name and e-mail.

200 status code is returned when there's at least one public wish list.

If no wishlists were found, an empty ResourceCollection will be returned.

Cartridge

app_sf_rest

Application

B2C Web Shop, 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.wishlist.PublicWishlistListResource

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.wishlist.PublicWishlistListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>

Response Example

{    "elements":
    [
        {
            "type": "Link",
            "description": "UpdatedWishlist 123",
            "title": "2bYKDgBeD.QAAAFCpNI_4H9L",
            "uri": "PrimeTech-PrimeTechBusiness-Site/smb-web-shop/wishlists/2bYKDgBeD.QAAAFCpNI_4H9L;owner=22gKDgBeb7wAAAFCLnhCtGv2"
        }
    ],
    "type": "ResourceCollection",
    "name": "Wishlists"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.common.capi.resource.wishlist.PublicWishlistListResource

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resource.wishlist.PublicWishlistListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>

XML Response Example



<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="Wishlists" type="ResourceCollection">
  <elements>
    <Link type="Link">
      <description>UpdatedWishlist 123</description>
      <title>2bYKDgBeD.QAAAFCpNI_4H9L</title>
      <uri>PrimeTech-PrimeTechBusiness-Site/smb-web-shop/wishlists/2bYKDgBeD.QAAAFCpNI_4H9L;owner=22gKDgBeb7wAAAFCLnhCtGv2</uri>
    </Link>
  </elements>
</ResourceCollection>

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