Personal Library

Kbid	2259K0
Last Modified	23-Jun-2020
Added to KB	25-May-2011
Public Access	Everyone
Status	Online
Doc Type	References
Product	ICM 7.7 ICM 7.8 ICM 7.9 ICM 7.10

REST API - Get promotion details

https://support.intershop.com/kb/2259K0

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><img src="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]" border="0" alt="free shipping!" width="35" height="35" /></icon> <legalContentMessage><span style="color: #808080;">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.</span></legalContentMessage> <longTitle><strong>Free shipping on orders with an LED TV.</strong></longTitle> <promotionType>ShippingPercentageOffDiscount</promotionType> <ruleDescription>Buy any LED TV and the order ships free.</ruleDescription> <title><span style="color: #ff0000;"><strong><span style="font-size: small;">free shipping!</span></strong></span></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.