REST API OCST - Get Promotion Details

URI

/channels/<channelID>/promotions/<promotionID>

Http Method

GET

Short Description

Returns information on a single promotion

Query Parameters

Example Requests

/channels/PrimeTech-PrimeTechSpecials/promotions/CC_20EUR_OrderDiscount

HTTP Status Codes

200 OK
404 Not found

Description

Get information on a single promotion.

Cartridge

app_sf_contactcenter_rest

Application

ContactCenter

Product Version

7.5.1

Product To Version

Status

final

JSON

Request Data Format

Request related java object

com.intershop.application.contactcenter.capi.rest.resource.PromotionResource

Request Example

 

Response Data Format

application/json

Response related java object

com.intershop.application.contactcenter.capi.rest.resource.PromotionResource
com.intershop.application.contactcenter.capi.rest.resourceobject.PromotionRO

Response Example

{
    "name": "20 EUR Order discount ",
    "type": "Promotion",
    "id": "CC_20EUR_OrderDiscount",
    "description": "Contact Center 20 EUR order discount coupon.",
    "links":
    {
        "elements":
        [
            {
                "type": "Link",
                "relation": "related",
                "title": "codes",
                "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_20EUR_OrderDiscount/codes"
            }
        ],
        "type": "ResourceCollection"
    }
}

XML

XML Request Data Format

XML Request Java Objects

com.intershop.application.contactcenter.capi.rest.resource.PromotionResource

XML Request Example

 

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.application.contactcenter.capi.rest.resource.PromotionResource
com.intershop.application.contactcenter.capi.rest.resourceobject.PromotionRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Promotion name="20 EUR Order discount " type="Promotion">
  <description>Contact Center 20 EUR order discount coupon.</description>
  <id>CC_20EUR_OrderDiscount</id>
  <links type="ResourceCollection">
    <elements>
      <Link type="Link">
        <relation>related</relation>
        <title>codes</title>
        <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_20EUR_OrderDiscount/codes</uri>
      </Link>
    </elements>
  </links>
</Promotion>

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