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:
The following operations for retrieving general promotion data are available:
/promotions{spgid}
This operation returns a personalized list of available promotions for the store. The response Resource Collection contains objects of Type LinkRO.
By default only promotions assigned to the customer group "Everyone" are returned. To retrieve personalized promotions based on direct customer assignment or customer segment, use the spgid parameter.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.PromotionResource.getPromotions(java.lang.Boolean)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | spgid | string | FUOGrzQ_VjORpGaN8DRGmLLE0000 | The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID> . Required if you want to work with customer-specific content. | |
in query | includeCodePromotions | boolean | false | true | Determines whether code-based promotions are returned. If set to true , the complete list of promotions is returned. If set to false , only promotions that do not require a promotion code are returned (default). |
200 - OK - The available promotions.
401 - Unauthorized - The user could not be authenticated.
/promotions{spgid}/{promotionID}
This operation returns details for a promotion. The response contains an object of Type PromotionRO.
By default, only information about a promotion assigned to the customer group "Everyone" can be returned. To retrieve information about a personalized promotion based on a direct customer assignment or a customer segment, use the spgid parameter.
public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.PromotionResource.getPromotionByID(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | spgid | string | FUOGrzQ_VjORpGaN8DRGmLLE0000 | The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID> . Required if you want to work with customer-specific content. | |
in path | promotionID | string | 10PercentageOffOnAudioEquipment | Required | The promotion ID |
200 - OK - The promotion with the given ID.
401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The promotion could not be found.
The following operations for retrieving product-specific promotions are available:
/categories/{categoriesKey}/products/{productKey}/promotions{spgid}
This operation returns a list of all promotions which are applicable for the current product.
By default only promotions assigned to the customer group "Everyone" are returned. To retrieve personalized promotions based on direct customer assignment or customer segment, use the spgid
parameter.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.promotion.ProductPromotionResource.getProductPromotions(java.lang.Boolean)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | spgid | string | FUOGrzQ_VjORpGaN8DRGmLLE0000 | The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID> . Required if you want to work with customer-specific content. | |
in path | categoriesKey | string | 151 | Required | The category ID | |
in path | productKey | string | 201807231 | Required | The product ID | |
in query | includeCodePromotions | boolean | false | true | Determines whether code-based promotions are returned. If set to true , the complete list of promotions is returned. If set to false , only promotions that do not require a promotion code are returned (default). |
200 - OK - The applicable promotions for the given product.
401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The promotion could not be found.
/products/{productKey}/promotions{spgid}
This operation returns a list of all promotions which are applicable for the current product.
By default only promotions assigned to the customer group "Everyone" are returned. To retrieve personalized promotions based on direct customer assignment or customer segment, use the spgid
parameter.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.promotion.ProductPromotionResource.getProductPromotions(java.lang.Boolean)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | spgid | string | FUOGrzQ_VjORpGaN8DRGmLLE0000 | The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID> . Required if you want to work with customer-specific content. | |
in path | productKey | string | 201807231 | Required | The product ID | |
in query | includeCodePromotions | boolean | false | true | Determines whether code-based promotions are returned. If set to true , the complete list of promotions is returned. If set to false , only promotions that do not require a promotion code are returned (default). |
200 - OK - The applicable promotions for the given product.
401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The promotion could not be 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
string
literals. The keys to sort forPromotion
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
USD
FreeOledTvShipping
For LED TVs the shipping is free.
ShippingPercentageOffDiscount
Free shipping on orders with an LED TV.
Offer valid only while supplies last (...)
Buy any LED TV and the order ships free.
free shipping!
false
http://www.abc.de
true
true
AttachmentRO
objects.AttachmentRO
LinkRO
object. 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
ResourceAttribute
object. An attributeResourceAttribute