Document Properties
Kbid
310H62
Last Modified
08-Feb-2024
Added to KB
13-Nov-2023
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 7.10
Reference - Wish List REST API 1.1.1 (ICM 7.10)
Document View


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

References

The following page lists available REST APIs for ICM 7.10 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
Wishlist Version: 1.1.1

Changelog


Version 1.1.1

  • Added this changelog
  • Added a fallback value of -1 for creationDate if the value is not available
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. However,
only the wishlists of the first 100 matching owners will be returned.
This means that if the first 100 owners matching your search criteria do not have a public wishlist,
you may get an empty result set.

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

LocationNameFormatDefaultExampleDescription
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

LocationNameFormatDefaultExampleDescription
in pathPublicWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

WishlistSettingsRO application/json

400 - Bad Request

401 - Unauthorized

/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/{CustomerWishlistKey}
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. However,
only the wishlists of the first 100 matching owners will be returned.
This means that if the first 100 owners matching your search criteria do not have a public wishlist,
you may get an empty result set.

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.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.getWishlist()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathproductSKUstringRequired
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item
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

LocationNameFormatDefaultExampleDescription
in pathproductSKUstringRequired
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerPurchaseWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item
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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

WishlistSettingsRO application/json

400 - Bad Request

401 - Unauthorized

/privatecustomers/{CustomerKey}/wishlists/{CustomerWishlistKey}
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. However,
only the wishlists of the first 100 matching owners will be returned.
This means that if the first 100 owners matching your search criteria do not have a public wishlist,
you may get an empty result set.

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.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.getWishlist()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathproductSKUstringRequired
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item
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

LocationNameFormatDefaultExampleDescription
in pathproductSKUstringRequired
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerPurchaseWishlistKeystringExampleKeyRequired | The key or UUID to resolve a single item
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
    Readonly | The name of an element | Example: WishList
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: WishList
  • "preferred":
    boolean
    indicates whether this wishlist is the preferred one
  • "items":
    array
    Readonly | 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
    Readonly | the count of the wishlists items | Format: int32 | Example: 1
  • "title":
    string
    The title of the wish list | Example: Patricias wish list
  • "creationDate":
    integer
    Deprecated | Readonly | The creation date of the wish list. If the creationDate is not available, -1 will be returned. | 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 element. This is normally a constant that can be used to differentiate elements 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 element. This is normally a constant that can be used to differentiate elements 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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.