This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
/wishlists
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.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | firstname | string | The first name of the wishlist owner | ||
in query | lastname | string | The last name of the wishlist owner | ||
in query | string | The email of the wishlist owner |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {PublicWishlistKey}
in subsequent requests. Links to item of type WishListRO./wishlists/{PublicWishlistKey}
Returns details, in resource object, about a public wish list created by private customer or user of a business customer.
public com.intershop.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.wishlist.PublicWishlistItemResource.getWishlist()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | PublicWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK is returned when the wish list and its owner are existing and the wish list belongs to the owner
404 - Not Found when either of the required IDs are wrong or invalid.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists
Returns a list of links to customer wish list resources.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistListResource.getWishlists()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerWishlistKey}
in subsequent requests. Links to item of type WishListRO.401 - Unauthorized
Creates a new customer wish list by using POST data provided by the client.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
201 - Created
400 - Bad Request
401 - Unauthorized
/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/settings
public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.WishlistSettingsRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSettingsResource.getWishlistSettings()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
Updates a customer wish list settings with wish list settings data provided from the client.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request
401 - Unauthorized
/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/{CustomerWishlistKey}
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.
public com.intershop.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.getWishlist()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
404 - Not Found
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
404 - Not Found
Delete a customer wish list.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.deleteWishList()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
404 - Not Found
/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/{CustomerWishlistKey}/products/{productSKU}
public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemProductItemResource.addItem(java.lang.String,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productSKU | string | Required | ||
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | quantity | string |
201 - Created
401 - Unauthorized
404 - Not Found
public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemProductItemResource.deleteItem(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productSKU | string | Required | ||
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
404 - Not Found
/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/{CustomerWishlistKey}/share
public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.share(com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.share.WishlistSharingRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
201 - Created
400 - Bad Request possible values for header error-key:
- account.wishlist.invalid_fields.error
401 - Unauthorized
404 - Not Found
Cancels a sharing of wishlist; removes the shared secure code and marks the wishlist as private.
public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.unshare()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
404 - Not Found
public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.share.WishlistSharingRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.getExample()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request
401 - Unauthorized
404 - Not Found
/customers/{CustomerKey}/users/{CustomerItemUserKey}/wishlists/{CustomerWishlistKey}/{CustomerPurchaseWishlistKey}/purchase
The query parameter quantity
is optional
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerPurchaseWishlistItemResource.addItem(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerPurchaseWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | quantity | string |
201 - Created
400 - Bad Request possible values for header error-key:
- wishlist.quantity.invalid.error
401 - Unauthorized
404 - Not Found
/privatecustomers/{CustomerKey}/wishlists
Returns a list of links to customer wish list resources.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistListResource.getWishlists()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerWishlistKey}
in subsequent requests. Links to item of type WishListRO.401 - Unauthorized
Creates a new customer wish list by using POST data provided by the client.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
201 - Created
400 - Bad Request
401 - Unauthorized
/privatecustomers/{CustomerKey}/wishlists/settings
public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.WishlistSettingsRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSettingsResource.getWishlistSettings()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
Updates a customer wish list settings with wish list settings data provided from the client.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request
401 - Unauthorized
/privatecustomers/{CustomerKey}/wishlists/{CustomerWishlistKey}
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.
public com.intershop.sellside.rest.common.capi.resourceobject.WishListRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.getWishlist()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
404 - Not Found
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
404 - Not Found
Delete a customer wish list.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemResource.deleteWishList()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
404 - Not Found
/privatecustomers/{CustomerKey}/wishlists/{CustomerWishlistKey}/products/{productSKU}
public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemProductItemResource.addItem(java.lang.String,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productSKU | string | Required | ||
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | quantity | string |
201 - Created
401 - Unauthorized
404 - Not Found
public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistItemProductItemResource.deleteItem(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productSKU | string | Required | ||
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
404 - Not Found
/privatecustomers/{CustomerKey}/wishlists/{CustomerWishlistKey}/share
public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.share(com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.share.WishlistSharingRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
201 - Created
400 - Bad Request possible values for header error-key:
- account.wishlist.invalid_fields.error
401 - Unauthorized
404 - Not Found
Cancels a sharing of wishlist; removes the shared secure code and marks the wishlist as private.
public void com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.unshare()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
404 - Not Found
public com.intershop.sellside.rest.common.capi.resourceobject.customer.wishlist.share.WishlistSharingRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerWishlistSharingResource.getExample()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request
401 - Unauthorized
404 - Not Found
/privatecustomers/{CustomerKey}/wishlists/{CustomerWishlistKey}/{CustomerPurchaseWishlistKey}/purchase
The query parameter quantity
is optional
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.customer.wishlist.CustomerPurchaseWishlistItemResource.addItem(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerPurchaseWishlistKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | quantity | string |
201 - Created
400 - Bad Request possible values for header error-key:
- wishlist.quantity.invalid.error
401 - Unauthorized
404 - Not Found
int32
int32
int32
LinkRO
objects. The list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
ResourceCollection
string
literals. The keys to sort forWishList
WishList
LinkRO
objects. the wishlist items as LinkROsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
int32
| Example: 1
Patricias wish list
int64
| Example: 1401710462448
WishlistSettings
alice@web.de,alexandra@web.de
Hey, this is my wishlist!
John Doe