Related Documents
Document Properties
Kbid25V787
Last Modified23-Jun-2020
Added to KB05-Jun-2014
Public AccessEveryone
StatusOnline
Doc TypeReferences

REST API - Get private customer wish list details (until 7.4 CI)

URI

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

Http Method

GET

Short Description

Retrieves and returns details about customer's wish list to the client.

Query Parameters

none

Example Requests

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

HTTP Status Codes

200 OK
401 Unauthorized
404 Not found

Description

Returns a wish list details to the client.

Cartridge

app_sf_rest, app_sf_rest_b2c

Application

B2C Web Shop

Product Version

7.4

Product To Version

7.4.6

Status

final

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

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,
    "title": "Wishlist",
    "items":
    [
        {
            "type": "Link",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "scEKDgBe40AAAAFCwPE_4Hr8"
                },
                {
                    "name": "creationDate",
                    "type": "String",
                    "value": "Thu Nov 21 15:07:46 CET 2013"
                },
                {
                    "name": "desiredQuantity",
                    "type": "Quantity",
                    "value":
                    {
                        "value": 4,
                        "available": true,
                        "zero": false,
                        "negative": false,
                        "unit": "",
                        "positive": true
                    }
                },
                {
                    "name": "sku",
                    "type": "String",
                    "value": "859910"
                }
            ]
        }
    ],
    "itemsCount": 1
}

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

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">
  <items>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>scEKDgBe40AAAAFCwPE_4Hr8</value>
        </ResourceAttribute>
        <ResourceAttribute name="creationDate" type="String">
          <value>Thu Nov 21 15:07:46 CET 2013</value>
        </ResourceAttribute>
        <ResourceAttribute name="desiredQuantity" type="Quantity">
          <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="quantity" unit="">4</value>
        </ResourceAttribute>
        <ResourceAttribute name="sku" type="String">
          <value>859910</value>
        </ResourceAttribute>
      </attributes>
      <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910</uri>
    </Link>
  </items>
  <itemsCount>1</itemsCount>
  <preferred>false</preferred>
  <public>true</public>
  <title>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