Related Documents
Document Properties
Kbid28X149
Last Modified23-Jun-2020
Added to KB23-Jan-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.9
  • ICM 7.10

REST API - Get personalized promotion list


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/promotions

Http Method

GET

Short Description

Get a personalized list of promotions available for the store

Query Parameters

none

Example Requests

/promotions

or

/promotions;spgid=NbaQwWGD1u6RpDkoWPiAHHB60000

HTTP Status Codes

200 OK
404 Not Found

Description

A list of all applicable promotions for the current channel and application is returned.
The promotion list is personalized. This means that the results may differ from user to user depending on the user segment they belong to and the promotion assignment for the various groups.

  • The list contains links to the promotion details.
  • The results are determined in every request on the fly and not cached.

If the REST call is an authenticated one, spgid parameter should be provided also in the request URL or the request will be considered anonymous even if Authorization header is provided.The personalization id can be retrieved using /personalization call, see: REST API - Get Personalization ID

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.9

Product To Version

 

Status

final

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

Response Example

{
   "total": 2,
   "elements":
   [
	   {
		   "type": "Link",
		   "title": "Free Shipping on LED TVs",
		   "uri": "PrimeTech-PrimeTechSpecials-Site/-/promotions/FreeShippingOnLEDTVs"
	   },
	   {
		   "type": "Link",
		   "title": "Void Promotion",
		   "uri": "PrimeTech-PrimeTechSpecials-Site/-/promotions/1LEKDgAOt38AAAFBSm9G9O7d"
	   }
   ],
   "type": "ResourceCollection",
   "name": "promotions"
}

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="promotions" type="ResourceCollection">
	<elements>
		<Link type="Link">
			<title>Free Shipping on LED TVs</title>
			<uri>PrimeTech-PrimeTechSpecials-Site/-/promotions/FreeShippingOnLEDTVs</uri>
		</Link>
		<Link type="Link">
			<title>Void Promotion</title>
			<uri>PrimeTech-PrimeTechSpecials-Site/-/promotions/1LEKDgAOt38AAAFBSm9G9O7d</uri>
		</Link>
	</elements>
	<total>2</total>
</ResourceCollection>

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets