REST API OCST - Get Promotions

URI

/channels/<channelID>/promotions

Http Method

GET

Short Description

Returns promotions that are only available within the Contact Center

Query Parameters

Example Requests

/channels/PrimeTech-PrimeTechSpecials/promotions

Headers:

  • Authorization=... or authentication-token=...
  • UserOrganization =PrimeTech

HTTP Status Codes

200 OK

401 Unauthorized

Description

Returns all Contact Center specific promotions that belong to the specified channel

Cartridge

app_sf_contactcenter_rest

Application

ContactCenter

Product Version

7.5.1

Product To Version

Status

final

JSON

Request Data Format

application/json

Request related java object

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

Request Example

Response Data Format

application/json

Response related java object

com.intershop.application.contactcenter.capi.rest.resource.PromotionListResource
com.intershop.component.rest.capi.resourceobject.LinkRO

Response Example

{
    "elements":
    [
        {
            "type": "Link",
            "description": "Contact Center 10 EUR order discount coupon.",
            "title": "10 EUR Order discount ",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_10EUR_OrderDiscount",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "CC_10EUR_OrderDiscount"
                }
            ]
        },
        {
            "type": "Link",
            "description": "Contact Center 10 USD order discount coupon.",
            "title": "10 USD Order discount ",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_10USD_OrderDiscount",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "CC_10USD_OrderDiscount"
                }
            ]
        },
        {
            "type": "Link",
            "description": "Contact Center 20 EUR order discount coupon.",
            "title": "20 EUR Order discount ",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_20EUR_OrderDiscount",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "CC_20EUR_OrderDiscount"
                }
            ]
        },
        {
            "type": "Link",
            "description": "Contact Center 20 USD order discount coupon.",
            "title": "20 USD Order discount ",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_20USD_OrderDiscount",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "CC_20USD_OrderDiscount"
                }
            ]
        },
        {
            "type": "Link",
            "description": "Contact Center 50 EUR order discount coupon.",
            "title": "50 EUR Order discount ",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_50EUR_OrderDiscount",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "CC_50EUR_OrderDiscount"
                }
            ]
        },
        {
            "type": "Link",
            "description": "Contact Center 50 USD order discount coupon.",
            "title": "50 USD Order discount ",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_50USD_OrderDiscount",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "CC_50USD_OrderDiscount"
                }
            ]
        },
        {
            "type": "Link",
            "description": "Contact Center free shipping promotion",
            "title": "Free Shipping (EUR)",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_FreeShipping_EUR",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "CC_FreeShipping_EUR"
                }
            ]
        },
        {
            "type": "Link",
            "description": "Contact Center free shipping promotion",
            "title": "Free Shipping (USD)",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_FreeShipping_USD",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "CC_FreeShipping_USD"
                }
            ]
        }
    ],
    "type": "ResourceCollection",
    "name": "promotions"
  }
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

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

XML Request Example

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.application.contactcenter.capi.rest.resource.PromotionListResource
com.intershop.component.rest.capi.resourceobject.LinkRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="promotions" type="ResourceCollection">
  <elements>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>CC_10EUR_OrderDiscount</value>
        </ResourceAttribute>
      </attributes>
      <description>Contact Center 10 EUR order discount coupon.</description>
      <title>10 EUR Order discount </title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_10EUR_OrderDiscount</uri>
    </Link>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>CC_10USD_OrderDiscount</value>
        </ResourceAttribute>
      </attributes>
      <description>Contact Center 10 USD order discount coupon.</description>
      <title>10 USD Order discount </title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_10USD_OrderDiscount</uri>
    </Link>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>CC_20EUR_OrderDiscount</value>
        </ResourceAttribute>
      </attributes>
      <description>Contact Center 20 EUR order discount coupon.</description>
      <title>20 EUR Order discount </title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_20EUR_OrderDiscount</uri>
    </Link>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>CC_20USD_OrderDiscount</value>
        </ResourceAttribute>
      </attributes>
      <description>Contact Center 20 USD order discount coupon.</description>
      <title>20 USD Order discount </title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_20USD_OrderDiscount</uri>
    </Link>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>CC_50EUR_OrderDiscount</value>
        </ResourceAttribute>
      </attributes>
      <description>Contact Center 50 EUR order discount coupon.</description>
      <title>50 EUR Order discount </title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_50EUR_OrderDiscount</uri>
    </Link>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>CC_50USD_OrderDiscount</value>
        </ResourceAttribute>
      </attributes>
      <description>Contact Center 50 USD order discount coupon.</description>
      <title>50 USD Order discount </title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_50USD_OrderDiscount</uri>
    </Link>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>CC_FreeShipping_EUR</value>
        </ResourceAttribute>
      </attributes>
      <description>Contact Center free shipping promotion</description>
      <title>Free Shipping (EUR)</title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_FreeShipping_EUR</uri>
    </Link>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>CC_FreeShipping_USD</value>
        </ResourceAttribute>
      </attributes>
      <description>Contact Center free shipping promotion</description>
      <title>Free Shipping (USD)</title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions/CC_FreeShipping_USD</uri>
    </Link>
  </elements>
</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