Related Documents
Document Properties
Kbid254M64
Last Modified26-Nov-2018
Added to KB09-Jan-2014
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get the applicable promotions for a product category


Note

Starting with 7.10 our REST API is documented using Swagger notation accessible at developer.cloud.intershop.com.

URI

/categories/<catID>/<subCatID>/.../products/<sku>/promotions

Http Method

GET

Short Description

Get the applicable promotions for a product category

Query Parameters

none

Example Requests

/categories/Telecommunication/CellPhones/products/2928109/promotions

HTTP Status Codes

200 OK

404 Not Found

Description

The following details/attributes are listed for each promotion applicable to the product:

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Additional notes

"uri" attributs will point to invalid locations in 7.4

  • invalid: <siteName>/-/categories/<catID>/<subCatID>/.../products/<sku>/promotions/<promotionID>
  • workaround: cut the uri to <siteName>/-/promotions/<promotionID>

fixed in 7.5

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.resource.PromotionResource
com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

Response Example

Request URL: /categories/Telecommunication/CellPhones/products/2928109/promotions

{
	"elements":
	[
		{
			"type": "Link",
			"uri": "PrimeTech-PrimeTechSpecials-Site/-/promotions/FreeShippingOnLEDTVs",
			"title": "Free Shipping on LED TVs"
		}
	],
	"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.sellside.rest.common.capi.resource.PromotionResource
com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

XML Response Example

Request URL: /categories/Telecommunication/CellPhones/products/2928109/promotions

<?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>
	</elements>
</ResourceCollection>


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
Support Tickets