The Intershop Customer Support website uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Further information on privacy can be found in the Intershop Privacy Policy and Legal Notice.
OK
Related Documents
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Reference - ICM REST API - B2B Front End - Wish List 1.0.0
Document Properties
Kbid29X616
Last Modified02-Nov-2020
Added to KB11-Sep-2020
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.10
⋮

Reference - ICM REST API - B2B Front End - Wish List 1.0.0

https://support.intershop.com/kb/29X616
Share this document


Product Version

7.10

Product To Version


Status

final

Download Specification 

This API specification is available for download as an Open API 3.0 YAML file: 

API Specification

Introduction

OpenAPI Version: 3.0.1
Wishlist Version: 1.0.0

This is Intershop ICM REST API documentation.

This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.
This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
You can find more information at Intershop Communications. Contact our Intershop experts at Support - Intershop Communications

Introduction

This API is documented in OpenAPI format.

Public Wishlists API

/wishlists
GET: Public wishlists

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.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.wishlist.PublicWishlistListResource.getWishlist(java.lang.String,java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in queryfirstnamestringThe first name of the wishlist owner
in querylastnamestringThe last name of the wishlist owner
in queryemailstringThe email of the wishlist owner

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {PublicWishlistKey} in subsequent requests. Links to item of type WishListRO.
/wishlists/{PublicWishlistKey}
GET: Get public wishlist details

Description

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

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.wishlist.PublicWishlistItemResource.getWishlist()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathPublicWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

is returned when the wish list and its owner are existing and the wish list belongs to the owner
WishListRO application/json

404 - Not Found

when either of the required IDs are wrong or invalid.

Wishlist API

/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists
GET: Get list of wishlists of customer

Description

Returns a list of links to customer wish list resources.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistListResource.getWishlists()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {CustomerWishlistKey} in subsequent requests. Links to item of type WishListRO.

401 - Unauthorized

POST: create new customer wishlist

Description

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

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistListResource.createWishlist(com.intershop.sellside.rest.common.capi.resourceobject.WishListRO)

Request Body

WishListRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

201 - Created

400 - Bad Request

401 - Unauthorized

/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/settings
GET: Get wisthlist settings of customer

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.WishlistSettingsRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSettingsResource.getWishlistSettings()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishlistSettingsRO application/json

401 - Unauthorized

PUT: Update customer wishlist settings

Description

Updates a customer wish list settings with wish list settings data provided from the client.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.WishlistSettingsRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSettingsResource.updateWishlistSettings(com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.WishlistSettingsRO)

Request Body

WishlistSettingsRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishlistSettingsRO application/json

400 - Bad Request

401 - Unauthorized

/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/{CustomerWishlistKey}
GET: Get customer wishlist details

Description

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

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.getWishlist()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishListRO application/json

401 - Unauthorized

404 - Not Found

PUT: Update customer wishlist

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.updateWishlist(com.intershop.sellside.rest.common.capi.resourceobject.WishListRO)

Request Body

WishListRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishListRO application/json

401 - Unauthorized

404 - Not Found

DELETE: Delete customer wishlist

Description

Delete a customer wish list.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.deleteWishList()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/{CustomerWishlistKey}/products/{productSKU}
POST: Add product to specific or preferred Wishlist

Description

--

Java Method

public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemProductItemResource.addItem(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathproductSKUstringRequired
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryquantitystring

Response

201 - Created

401 - Unauthorized

404 - Not Found

DELETE: Remove product from specific or preferred wishlist

Description

--

Java Method

public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemProductItemResource.deleteItem(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathproductSKUstringRequired
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/{CustomerWishlistKey}/share
POST: Share wishlist of customer with given recipient

Description

--

Java Method

public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.share(com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.share.WishlistSharingRO)

Request Body

WishlistSharingRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

201 - Created

400 - Bad Request

possible values for header error-key:
- account.wishlist.invalid_fields.error

401 - Unauthorized

404 - Not Found

DELETE: Unshare wishlist

Description

Cancels a sharing of wishlist; removes the shared secure code and marks the wishlist as private.

Java Method

public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.unshare()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

404 - Not Found

OPTIONS: Returns an example request data for the sharing capabilities

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.share.WishlistSharingRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.getExample()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishlistSharingRO application/json

400 - Bad Request

401 - Unauthorized

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/{CustomerWishlistKey}/{CustomerPurchaseWishlistKey}/purchase
POST: Add wishlist item to basket

Description

The query parameter quantity is optional

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerPurchaseWishlistItemResource.addItem(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerPurchaseWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryquantitystring

Response

201 - Created

400 - Bad Request

possible values for header error-key:
- wishlist.quantity.invalid.error

401 - Unauthorized

404 - Not Found

/privatecustomers/{CustomerKey}/wishlists
GET: Get list of wishlists of customer

Description

Returns a list of links to customer wish list resources.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistListResource.getWishlists()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {CustomerWishlistKey} in subsequent requests. Links to item of type WishListRO.

401 - Unauthorized

POST: create new customer wishlist

Description

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

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistListResource.createWishlist(com.intershop.sellside.rest.common.capi.resourceobject.WishListRO)

Request Body

WishListRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

201 - Created

400 - Bad Request

401 - Unauthorized

/privatecustomers/{CustomerKey}/wishlists/settings
GET: Get wisthlist settings of customer

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.WishlistSettingsRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSettingsResource.getWishlistSettings()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishlistSettingsRO application/json

401 - Unauthorized

PUT: Update customer wishlist settings

Description

Updates a customer wish list settings with wish list settings data provided from the client.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.WishlistSettingsRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSettingsResource.updateWishlistSettings(com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.WishlistSettingsRO)

Request Body

WishlistSettingsRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishlistSettingsRO application/json

400 - Bad Request

401 - Unauthorized

/privatecustomers/{CustomerKey}/wishlists/{CustomerWishlistKey}
GET: Get customer wishlist details

Description

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

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.getWishlist()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishListRO application/json

401 - Unauthorized

404 - Not Found

PUT: Update customer wishlist

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.updateWishlist(com.intershop.sellside.rest.common.capi.resourceobject.WishListRO)

Request Body

WishListRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishListRO application/json

401 - Unauthorized

404 - Not Found

DELETE: Delete customer wishlist

Description

Delete a customer wish list.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.deleteWishList()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

404 - Not Found

/privatecustomers/{CustomerKey}/wishlists/{CustomerWishlistKey}/products/{productSKU}
POST: Add product to specific or preferred Wishlist

Description

--

Java Method

public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemProductItemResource.addItem(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathproductSKUstringRequired
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryquantitystring

Response

201 - Created

401 - Unauthorized

404 - Not Found

DELETE: Remove product from specific or preferred wishlist

Description

--

Java Method

public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemProductItemResource.deleteItem(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathproductSKUstringRequired
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

404 - Not Found

/privatecustomers/{CustomerKey}/wishlists/{CustomerWishlistKey}/share
POST: Share wishlist of customer with given recipient

Description

--

Java Method

public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.share(com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.share.WishlistSharingRO)

Request Body

WishlistSharingRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

201 - Created

400 - Bad Request

possible values for header error-key:
- account.wishlist.invalid_fields.error

401 - Unauthorized

404 - Not Found

DELETE: Unshare wishlist

Description

Cancels a sharing of wishlist; removes the shared secure code and marks the wishlist as private.

Java Method

public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.unshare()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

404 - Not Found

OPTIONS: Returns an example request data for the sharing capabilities

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.share.WishlistSharingRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.getExample()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

WishlistSharingRO application/json

400 - Bad Request

401 - Unauthorized

404 - Not Found

/privatecustomers/{CustomerKey}/wishlists/{CustomerWishlistKey}/{CustomerPurchaseWishlistKey}/purchase
POST: Add wishlist item to basket

Description

The query parameter quantity is optional

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerPurchaseWishlistItemResource.addItem(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerPurchaseWishlistKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryquantitystring

Response

201 - Created

400 - Bad Request

possible values for header error-key:
- wishlist.quantity.invalid.error

401 - Unauthorized

404 - Not Found

Request and Response Object Schemata

ResourceCollectionROLinkRO application/json{
  • "pageable":
    string
    the pageable ID
  • "total":
    integer
    the pageable amount total | Format: int32
  • "offset":
    integer
    the pageable offset | Format: int32
  • "amount":
    integer
    the pageable amount | Format: int32
  • "elements":
    array
    An array of LinkRO objects. the list of elements
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    This is a constant: ResourceCollection | Example: ResourceCollection
  • "sortKeys":
    array
    An array of string literals. the keys to sort for
  • "name":
    string
    the name of the returned element
}
WishListRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: WishList
  • "preferred":
    boolean
    indicates whether this wishlist is the preferred one
  • "items":
    array
    An array of LinkRO objects. the wishlist items as LinkROs
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "itemsCount":
    integer
    the count of the wishlists items | Format: int32 | Example: 1
  • "title":
    string
    The title of the Wishlist | Example: Patricias Wishlist
  • "creationDate":
    integer
    The creation Date of the wishlist | Format: int64 | Example: 1401710462448
  • "public":
    boolean
    indicates whether this wishlist is public
}
WishlistSettingsRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: WishlistSettings
  • "uri":
    string
    the uri of the wishlist settings
  • "usePreferredWishlist":
    boolean
    indicates whether this is the preffered wishlist
}
WishlistSharingRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "recipients":
    string
    a list of valid email-addresses to whom a wishlist sharing invitation would be sent | Example: alice@web.de,alexandra@web.de
  • "message":
    string
    the sharing message | Example: Hey, this is my wishlist!
  • "sender":
    string
    the sender of the wishlist sharing invitation | Example: John Doe
}

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.

Support Europe
+49 (3641)501600
support@intershop.de
Corporate Headquarters
Intershop Communications AG
Leutragraben 1
07743 Jena
Germany
Support America
(415) 844-3730
support@intershop.com
Customer Support
Home Page
How To Contact Us
ISO 9001 Certified
Support Plans
Additional Services
Product Support Matrix
Support Newsletter
Contract Datasheet
Feedback Form
Support News Archive
Knowledge Base
Home Page
Search
Personal Library
Product Resources
Home Page
Search
Custom Fixes for your Account
Difference Report
Product Support Matrix
Service Connector Matrix
Tickets
Home Page
Search
Ticket Statistics
New Ticket