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:
/customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications
This operation returns links to the stock and price notification endpoints of a user.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationsBaseResource.getNotifications()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
/privatecustomers/{CustomerKey}/notifications
This operation returns links to the stock and price notification endpoints of a user.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationsBaseResource.getNotifications()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID |
200 - OK
/customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications/price
This operation returns links to the price notifications of a customer.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource.getNotifications()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
This operation creates a new price notification.
The body must contain the sku
, the price
, and a notificationMailAddress
to inform the user when the product price drops below this value.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource.createProductNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.NewProductNotificationRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
201 - Created
400 - Bad Request - possible values for header error-key:
- account.productnotification.invalid_fields.error
- account.productnotification.missing_fields.error
- account.productnotification.product.in_stock.error
401 - Unauthorized
404 - Not Found - possible values for header error-key:
- account.productnotification.product.not_found.error
409 - Conflict - A price notification for this product already exists.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications/price/{CustomerProductPriceNotificationResourceKey}
This operation returns details about a specific price notification.
public com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.getProductPriceNotification()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductPriceNotificationResourceKey | string | Required | Price notification ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
404 - Not Found
This operation updates an existing price notification.
The body must contain a price
and a notificationMailAddress
to inform the user when the product price drops below this value.
public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.updateProductPriceNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductPriceNotificationResourceKey | string | Required | Price notification ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request possible values for header error-key:
- account.productnotification.invalid_fields.error
- account.productnotification.missing_fields.error
401 - Unauthorized
403 - Forbidden
404 - Not Found
This operation deletes an existing price notification.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.deleteProductPriceNotification()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductPriceNotificationResourceKey | string | Required | Price notification ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
403 - Forbidden
404 - Not Found
/privatecustomers/{CustomerKey}/notifications/price
This operation returns links to the price notifications of a customer.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource.getNotifications()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerProductPriceNotificationResourceKey}
in subsequent requests. Links to item of type ProductNotificationRO.This operation creates a new price notification.
The body must contain the sku
, the price
, and a notificationMailAddress
to inform the user when the product price drops below this value.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource.createProductNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.NewProductNotificationRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID |
201 - Created
400 - Bad Request - possible values for header error-key:
- account.productnotification.invalid_fields.error
- account.productnotification.missing_fields.error
- account.productnotification.product.in_stock.error
401 - Unauthorized
404 - Not Found - possible values for header error-key:
- account.productnotification.product.not_found.error
409 - Conflict - A price notification for this product already exists.
/privatecustomers/{CustomerKey}/notifications/price/{CustomerProductPriceNotificationResourceKey}
This operation returns details about a specific price notification.
public com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.getProductPriceNotification()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductPriceNotificationResourceKey | string | Required | Price notification ID |
200 - OK
401 - Unauthorized
404 - Not Found
This operation updates an existing price notification.
The body must contain a price
and a notificationMailAddress
to inform the user when the product price drops below this value.
public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.updateProductPriceNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductPriceNotificationResourceKey | string | Required | Price notification ID |
200 - OK
400 - Bad Request possible values for header error-key:
- account.productnotification.invalid_fields.error
- account.productnotification.missing_fields.error
401 - Unauthorized
403 - Forbidden
404 - Not Found
This operation deletes an existing price notification.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.deleteProductPriceNotification()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductPriceNotificationResourceKey | string | Required | Price notification ID |
204 - No Content
401 - Unauthorized
403 - Forbidden
404 - Not Found
/customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications/stock
This operation returns links to the back in stock notifications of a customer.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource.getNotifications()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
This operation creates a new back in stock notification.
The body must contain the sku
and a notificationMailAddress
which is used to inform the user when the product is in stock again.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource.createProductNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.NewProductNotificationRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
201 - Created
400 - Bad Request - possible values for header error-key:
- account.productnotification.invalid_fields.error
- account.productnotification.missing_fields.error
- account.productnotification.product.in_stock.error
401 - Unauthorized
404 - Not Found - possible values for header error-key:
- account.productnotification.product.not_found.error
409 - Conflict - A stock notification for this product already exists.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications/stock/{CustomerProductStockNotificationResourceKey}
This operation returns details of a specific back in stock notification.
public com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.getProductStockNotification()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductStockNotificationResourceKey | string | Required | Stock notification ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
404 - Not Found
This operation updates an existing back in stock notification.
The body must contain a notificationMailAddress
which is used to inform the user when the product is in stock again.
public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.updateProductStockNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductStockNotificationResourceKey | string | Required | Stock notification ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request possible values for headere error-key:
- account.productnotification.invalid_fields.error
- account.productnotification.missing_fields.error
401 - Unauthorized
403 - Forbidden
404 - Not Found
This operation deletes an existing back in stock notification.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.deleteProductStockNotification()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductStockNotificationResourceKey | string | Required | Stock notification ID | ||
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
403 - Forbidden
404 - Not Found
/privatecustomers/{CustomerKey}/notifications/stock
This operation returns links to the back in stock notifications of a customer.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource.getNotifications()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerProductStockNotificationResourceKey}
in subsequent requests. Links to item of type ProductNotificationRO.This operation creates a new back in stock notification.
The body must contain the sku
and a notificationMailAddress
which is used to inform the user when the product is in stock again.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource.createProductNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.NewProductNotificationRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID |
201 - Created
400 - Bad Request - possible values for header error-key:
- account.productnotification.invalid_fields.error
- account.productnotification.missing_fields.error
- account.productnotification.product.in_stock.error
401 - Unauthorized
404 - Not Found - possible values for header error-key:
- account.productnotification.product.not_found.error
409 - Conflict - A stock notification for this product already exists.
/privatecustomers/{CustomerKey}/notifications/stock/{CustomerProductStockNotificationResourceKey}
This operation returns details of a specific back in stock notification.
public com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.getProductStockNotification()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductStockNotificationResourceKey | string | Required | Stock notification ID |
200 - OK
401 - Unauthorized
404 - Not Found
This operation updates an existing back in stock notification.
The body must contain a notificationMailAddress
which is used to inform the user when the product is in stock again.
public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.updateProductStockNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductStockNotificationResourceKey | string | Required | Stock notification ID |
200 - OK
400 - Bad Request possible values for headere error-key:
- account.productnotification.invalid_fields.error
- account.productnotification.missing_fields.error
401 - Unauthorized
403 - Forbidden
404 - Not Found
This operation deletes an existing back in stock notification.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.deleteProductStockNotification()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | Required | Customer ID | ||
in path | CustomerProductStockNotificationResourceKey | string | Required | Stock notification ID |
204 - No Content
401 - Unauthorized
403 - Forbidden
404 - Not Found
10809311
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
pmiller@test.intershop.de
ProductNotification
10809311
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
pmiller@test.intershop.de
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 for