REST API - Public wish list details


Note

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

URI

/wishlists/<wishlistID>

Http Method

GET

Short Description

Returns details about public wish list

Query Parameters

none

Example Requests

/wishlists/<wishtlidID>;owner=<userID>

HTTP Status Codes

200 OK
404 Not found

Description

Returns details, in resource object, about a public wish list created by private customer or user of a business customer.

200 status code is returned when the wish list and its owner are existing and the wish list belongs to the owner
404 - when either of the required IDs are wrong or invalid.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.5

Product To Version


Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.b2c.capi.resource.wishlist.PublicWishlistItemResource

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.b2c.capi.resource.wishlist.PublicWishlistItemResource
com.intershop.sellside.rest.b2c.capi.resourceobject.WishListRO
com.intershop.sellside.rest.b2c.capi.resourceobject.WishListItemRO

Response Example

{
    "type": "WishList",
	"creationDate": 1401698205644,
    "itemsCount": 1,
    "title": "Christmas Wishlist",
    "items": [
        {
            "type": "Link",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/products/10809311",
            "attributes": [
                {
                    "name": "id",
                    "type": "String",
                    "value": "c0YKDACqMs8AAAFBuNxHvOUK"
                },
                {
                    "name": "creationDate",
                    "type": "String",
                    "value": 1401698205667
                },
                {
                    "name": "desiredQuantity",
                    "type": "ResourceAttribute",
                    "value": {
						"type": "Quantity",
                        "value": 1,
                        "unit": "N/A"
                    }
                },
                {
                    "name": "sku",
                    "type": "ResourceAttribute",
                    "value": "10809311"
                }
            ]
        }
    ]
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.b2c.capi.resource.wishlist.PublicWishlistItemResource

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.b2c.capi.resource.wishlist.PublicWishlistItemResource
com.intershop.sellside.rest.b2c.capi.resourceobject.WishListRO
com.intershop.sellside.rest.b2c.capi.resourceobject.WishListItemRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<WishList type="WishList">
	<creationDate>1401698205644</creationDate>    
	<items>
        <Link type="Link">
            <attributes>
                <ResourceAttribute name="id" type="String">
                    <value>c0YKDACqMs8AAAFBuNxHvOUK</value>
                </ResourceAttribute>
                <ResourceAttribute name="creationDate" type="Long">
                    <value 
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                        xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:long">1401698205667
                    </value>
                </ResourceAttribute>
               	<ResourceAttribute name="desiredQuantity" type="ResourceAttribute">
		 			<value type="Quantity">
    	       			<unit>N/A</unit>
    			        <value>1</value>
					</value>
		        </ResourceAttribute>
                <ResourceAttribute name="sku" type="String">
                    <value>10809311</value>
                </ResourceAttribute>
            </attributes>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/products/10809311</uri>
        </Link>
    </items>
    <itemsCount>1</itemsCount>
    <title>Christmas 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
Tickets