Related Documents
Document Properties
Kbid2259K0
Last Modified23-Jun-2020
Added to KB25-May-2011
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get promotion details


Note

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

URI

/promotions/<promotionID>

Http Method

GET

Short Description

Get relevant details for a promotion

Query Parameters

none

Example Requests

/promotions/FreeShippingOnLEDTVs

HTTP Status Codes

200 OK
404 Not Found

Description

Get relevant details for a promotion

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

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.sellside.rest.common.capi.resourceobject.PromotionRO

Response Example

{
   "name": "Free Shipping on LED TVs",
   "type": "Promotion",
   "description": "For LED TVs the shipping is free.",
   "title": "free shipping!",
   "currency": "USD",
   "legalContentMessage": "Offer valid only while supplies last and not applicable to canceled orders due to out-of-stock merchandise. Discount not applicable with returned merchandise; total discount will be deducted from the value of any returned item to which the discount applied. This offer is not valid on previous purchases. This promotional offer may be modified or terminated at any time without notice. We reserve the right to cancel any order due to unauthorized, altered, or ineligible use of a discount.",
   "promotionType": "ShippingPercentageOffDiscount",
   "ruleDescription": "Buy any LED TV and the order ships free.",
   "icon": "free shipping!",
   "longTitle": "Free shipping on orders with an LED TV.",
   "couponCodeRequired": false
}

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.sellside.rest.common.capi.resourceobject.PromotionRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Promotion name="Free Shipping on LED TVs" type="Promotion">
	<couponCodeRequired>false</couponCodeRequired>
	<currency>USD</currency>
	<description>For LED TVs the shipping is free.</description>
	<icon>&lt;img src=&quot;https://./?[ismediaobject]isfile://PrimeTech-PrimeTechSpecials-Site/-/PrimeTech-PrimeTechSpecials/en_US/images/PromotionSave.gif|/INTERSHOP/static/WFS/PrimeTech-PrimeTechSpecials-Site/-/PrimeTech-PrimeTechSpecials/en_US/images/PromotionSave.gif[/ismediaobject]&quot; border=&quot;0&quot; alt=&quot;free shipping!&quot; width=&quot;35&quot; height=&quot;35&quot; /&gt;</icon>
	<legalContentMessage>&lt;span style=&quot;color: #808080;&quot;&gt;Offer valid only while supplies last and not applicable to canceled orders due to out-of-stock merchandise. Discount not applicable with returned merchandise; total discount will be deducted from the value of any returned item to which the discount applied. This offer is not valid on previous purchases. This promotional offer may be modified or terminated at any time without notice. We reserve the right to cancel any order due to unauthorized, altered, or ineligible use of a discount.&lt;/span&gt;</legalContentMessage>
	<longTitle>&lt;strong&gt;Free shipping on orders with an LED TV.&lt;/strong&gt;</longTitle>
	<promotionType>ShippingPercentageOffDiscount</promotionType>
	<ruleDescription>Buy any LED TV and the order ships free.</ruleDescription>
	<title>&lt;span style=&quot;color: #ff0000;&quot;&gt;&lt;strong&gt;&lt;span style=&quot;font-size: small;&quot;&gt;free shipping!&lt;/span&gt;&lt;/strong&gt;&lt;/span&gt;</title>
</Promotion>

Reference - WebShop REST APIs

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
Tickets