getPromotion
get
/ccadmin/v1/promotions/{id}
Get a promotion by ID. Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID corresponding to the promotion to get.
Query Parameters
-
enableConversion(optional): boolean
Enables promotion data conversion for promotions based on upgraded templates. Default value is 'false'.
-
showClaimablesInfo(optional): integer
Integer value to indicate number of single code and coupon batch coupons to be returned. When set to a value greater than 0, it returns 2 fields in response. 'totalClaimables' showing the total number of single code coupons and 'totalCouponBatches' showing the total number of coupon batches. Maximum coupons that can be retrieved in a request is 50.
-
showTranslations(optional): boolean
Boolean indicating if the translations property should be returned for each item in the response. Default value is false
-
useMaxUses(optional): boolean
Boolean indicating whether to return maxUses property of the claimables. Default value is 'false'.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
The following model is returned when the operation succeeds.
Root Schema : getPromotion_response
Type:
Show Source
object
-
allowMultiple(optional):
boolean
Determines whether the promotion can be given to a customer only once. If set to false, the system grants the promotion only once. If set to true, the system adds a copy of the promotion to the customer's profile every time the customer is granted the promotion.
-
audiences(optional):
array audiences
List of audiences to which the promotion is limited. An empty list implies no restrictions.
-
cardIINRanges(optional):
array cardIINRanges
List of issuer identification numbers including wildcards and ranges for which the promotion should be applied.
-
claimables(optional):
array claimables
The list of single coupon codes.
-
closenessQualifiers(optional):
array closenessQualifiers
Array of message sets that apply to a specific criteria for displaying a partially-qualified upsell message to a shopper. Partial qualification is based on the threshold value specified in templateValues.See online documentation for more details.
-
couponBatches(optional):
array couponBatches
This will list coupon batch details.
-
description(optional):
string
The Promotion description.
-
displayName(optional):
string
The display name of the promotion.
-
enabled(optional):
boolean
Whether or not the promotion is currently enabled.
-
endDate(optional):
string
When this promotion ceases to be active
-
evaluationLimit(optional):
integer
The evaluation limit.
-
excludedPromotions(optional):
array excludedPromotions
List of promotions to be excluded from the current promotion. Item promotions can exclude promotions of type: item, order, shipping. Order promotions can exclude promotion of type order and shipping. Shipping promotions can only exclude another shipping promotions.
-
filterForQualifierActedAsQualifier(optional):
boolean
Determines whether qualifiers can be reused in a promotion. If true, qualifiers can be used only once per promotion evaluation. Applicable to all promotion types. If unset, will be treated as true.
-
filterForQualifierDiscountedByAny(optional):
boolean
Determines whether items discounted by any promotion can act as qualifiers for other promotions. Applicable to all promotion types. If unset, will be treated as true.
-
filterForQualifierDiscountedByCurrent(optional):
boolean
Determines whether items discounted by the current promotion can act as qualifiers for other promotions. Applicable to item promotions. If unset, will be treated as true.
-
filterForQualifierNegativePrices(optional):
boolean
Determines whether items with negative prices can act as qualifiers for other promotions. Applicable to all promotion types. If unset, will be treated as true.
-
filterForQualifierOnSale(optional):
boolean
Determines whether items that were priced with a sale price should be allowed to act as qualifiers. Applicable to all promotion types. If unset, will be treated as false.
-
filterForQualifierZeroPrices(optional):
boolean
Determines whether items with zero prices can act as qualifiers. Applicable to all promotion types. If unset, will be treated as true.
-
filterForTargetActedAsQualifier(optional):
boolean
Determines whether items that have acted as a qualifier for any discount can receive the current discount. Applicable to item promotions. If unset, will be treated as true.
-
filterForTargetDiscountedByAny(optional):
boolean
Determines whether items that have been discounted by any promotion can receive another discount. Applicable to item promotions. If unset, will be treated as true.
-
filterForTargetDiscountedByCurrent(optional):
boolean
Determines whether items that have been discounted by the current promotion can receive the discount again. Applicable to item promotions. If unset, will be treated as true.
-
filterForTargetNegativePrices(optional):
boolean
Determines whether items with negative prices can receive the discount. Applicable to item promotions. If unset, will be treated as true.
-
filterForTargetOnSale(optional):
boolean
Determines whether items that were priced with a sale price should be allowed to receive the current discount. If unset, will be treated as true.
-
filterForTargetPriceLTOETPromoPrice(optional):
boolean
Determines whether to exclude items with price lower than promotion price. Applicable to item promotions. If unset, will be treated as true.
-
filterForTargetZeroPrices(optional):
boolean
Determines whether items with zero prices can receive the discount. Applicable to item promotions. If unset, will be treated as true.
-
giveToAnonymousProfiles(optional):
boolean
If both this property and the global property are false, then only registered visitors can receive the promotion. If this property is true, and the global property is false, then anonymous visitors and registered visitors can receive the promotion. In both cases, the visitors must meet any other conditions specified by the promotion in order to receive it.
-
global(optional):
boolean
Whether the promotion is global.
-
id(optional):
string
The Promotion id.
-
includedPromotions(optional):
array includedPromotions
List of promotions to be included in the current promotion.
-
maxUsesPerOrder(optional):
integer
Number of times a promotion can be applied to an order, -1 indicates that the same promotion can be applied unlimited number of times
-
parentFolder(optional):
object parentFolder
Parent Folder object of the current promotion.
-
priceListGroups(optional):
array priceListGroups
The list of price list groups to which promotion is associated.
-
priority(optional):
integer
The priority of this promotion over other promotions
-
qualifiedMessages(optional):
array qualifiedMessages
Promotion upsell messages to display when the shopper has qualified for the promotion.
-
repositoryId(optional):
string
The Promotion id.
-
shippingMethods(optional):
array shippingMethods
Array of shipping methods for which the promotion should be applied.
-
sites(optional):
array sites
This will limit the promotion to being applicable only to the 1+ specified sites. An empty array means the promotion applies to all sites.
-
stackingRule(optional):
object stackingRule
Represents a rule to determine a group of promotions that can be used together.
-
startDate(optional):
string
When this promotion becomes active
-
template(optional):
string
The template file name.
-
templateValues(optional):
object templateValues
Specifies the template values that are used as part of the promotion to control its behavior
-
totalClaimables(optional):
integer
Total number of claimables for the promotion.
-
totalCouponBatches(optional):
integer
Total number of coupon batches for the promotion.
-
type(optional):
integer
Integer representation of the promotion type (shipping, item, order).
-
unqualifiedMessages(optional):
array unqualifiedMessages
Promotion upsell messages to display when the shopper has not yet qualified for the promotion.
-
uses(optional):
integer
The number of orders for a given customer to which the promotion can be applied.
Nested Schema : audiences
Type:
array
List of audiences to which the promotion is limited. An empty list implies no restrictions.
Show Source
Nested Schema : cardIINRanges
Type:
array
List of issuer identification numbers including wildcards and ranges for which the promotion should be applied.
Show Source
Nested Schema : closenessQualifiers
Type:
array
Array of message sets that apply to a specific criteria for displaying a partially-qualified upsell message to a shopper. Partial qualification is based on the threshold value specified in templateValues.See online documentation for more details.
Show Source
Nested Schema : excludedPromotions
Type:
array
List of promotions to be excluded from the current promotion. Item promotions can exclude promotions of type: item, order, shipping. Order promotions can exclude promotion of type order and shipping. Shipping promotions can only exclude another shipping promotions.
Show Source
Nested Schema : includedPromotions
Type:
array
List of promotions to be included in the current promotion.
Show Source
Nested Schema : parentFolder
Type:
object
Parent Folder object of the current promotion.
Show Source
-
displayName(optional):
string
The name of the promotion folder.
-
repositoryId(optional):
string
The promotion folder's repository ID that the promotion is assigned to.
Nested Schema : priceListGroups
Type:
array
The list of price list groups to which promotion is associated.
Show Source
Nested Schema : qualifiedMessages
Type:
array
Promotion upsell messages to display when the shopper has qualified for the promotion.
Show Source
Nested Schema : shippingMethods
Type:
array
Array of shipping methods for which the promotion should be applied.
Show Source
Nested Schema : sites
Type:
array
This will limit the promotion to being applicable only to the 1+ specified sites. An empty array means the promotion applies to all sites.
Show Source
Nested Schema : stackingRule
Type:
object
Represents a rule to determine a group of promotions that can be used together.
Show Source
-
displayName(optional):
string
The name of the rule.
-
id(optional):
string
The stacking rule id.
-
maxPromotions(optional):
string
The maximum number of promotions that can be applied to an order based on this rule.
-
repositoryId(optional):
string
The stacking rule id
Nested Schema : templateValues
Type:
object
Specifies the template values that are used as part of the promotion to control its behavior
Show Source
-
condition_psc_value(optional):
object condition_psc_value
The condition product set criteria value
-
discount_type_value(optional):
string
The discount type
-
discount_value(optional):
string
The discount value
-
discountStructure(optional):
object discountStructure
The discount structure
-
gwpItem(optional):
object gwpItem
The gift with promotion configuration details
-
no_of_items_to_buy(optional):
string
The number of items to buy
-
no_of_items_to_discount(optional):
string
The number of items to discount
-
offer_psc_value(optional):
object offer_psc_value
The offer product set criteria values
-
optional_offer_psc_value(optional):
object optional_offer_psc_value
The offer product set criteria values
-
PSC_value(optional):
object PSC_value
The product set criteria values
-
sort_by(optional):
string
The sort by condition
-
sort_order(optional):
string
The sort order
-
spend_value(optional):
string
The spend value
Nested Schema : unqualifiedMessages
Type:
array
Promotion upsell messages to display when the shopper has not yet qualified for the promotion.
Show Source
Nested Schema : items
Type:
Show Source
object
-
repositoryId:
string
The ID of an audience associated with the promotion.
Nested Schema : items
Type:
Show Source
object
-
closenessMessages(optional):
array closenessMessages
Promotion upsell messages to display when the shopper has partially-qualified for the promotion.
-
repositoryId(optional):
string
The closeness qualifier's ID.
Nested Schema : closenessMessages
Type:
array
Promotion upsell messages to display when the shopper has partially-qualified for the promotion.
Show Source
Nested Schema : items
Type:
Show Source
object
-
message(optional):
string
Localizable text for the upsell message.
-
repositoryId(optional):
string
The message's ID.
-
tags(optional):
array tags
Array of message tags to use in associating where to display the message on the storefront.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The coupon batch id.
-
maxUses(optional):
integer
The max use count.
-
numberOfCoupons(optional):
integer
The number of coupons in batch.
-
prefix(optional):
string
The prefix of the coupons in batch.
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The promotion's repository ID
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The promotion's repository ID
Nested Schema : items
Type:
Show Source
object
-
message(optional):
string
Localizable text for the upsell message.
-
repositoryId(optional):
string
The message's ID.
-
tags(optional):
array tags
Array of message tags to use in associating where to display the message on the storefront.
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The ID of a site associated with the promotion.
Nested Schema : condition_psc_value
Type:
object
The condition product set criteria value
Show Source
-
excludedCategories(optional):
array excludedCategories
The excluded categories
-
excludedProducts(optional):
array excludedProducts
The excluded products
-
excludedSkus(optional):
array excludedSkus
The excluded SKU IDs
-
includedCategories(optional):
array includedCategories
The included categories
-
includedProducts(optional):
array includedProducts
The included products
-
includedSkus(optional):
array includedSkus
The included SKU IDs
Nested Schema : discountStructure
Type:
object
The discount structure
Show Source
-
discount_details(optional):
array discount_details
The discount details
-
discount_type_value(optional):
string
The discount type value
Nested Schema : gwpItem
Type:
object
The gift with promotion configuration details
Show Source
-
autoRemove(optional):
boolean
Whether to remove item from cart when cart no longer meets buy condition
-
giftId(optional):
string
The product id of the gift item
-
giftType(optional):
string
The gift item type
Nested Schema : offer_psc_value
Type:
object
The offer product set criteria values
Show Source
-
excludedCategories(optional):
array excludedCategories
The excluded categories
-
excludedProducts(optional):
array excludedProducts
The excluded products
-
excludedSkus(optional):
array excludedSkus
The excluded SKU IDs
-
includedCategories(optional):
array includedCategories
The included categories
-
includedProducts(optional):
array includedProducts
The included products
-
includedSkus(optional):
array includedSkus
The included SKU IDs
Nested Schema : optional_offer_psc_value
Type:
object
The offer product set criteria values
Show Source
-
excludedCategories(optional):
array excludedCategories
The excluded categories
-
excludedProducts(optional):
array excludedProducts
The excluded products
-
excludedSkus(optional):
array excludedSkus
The excluded SKU IDs
-
includedCategories(optional):
array includedCategories
The included categories
-
includedProducts(optional):
array includedProducts
The included products
-
includedSkus(optional):
array includedSkus
The included SKU IDs
-
sameAsCondition(optional):
boolean
Items to include and exclude for offer are the same as items in buy condition
Nested Schema : PSC_value
Type:
object
The product set criteria values
Show Source
-
excludedCategories(optional):
array excludedCategories
The excluded categories
-
excludedProducts(optional):
array excludedProducts
The excluded products
-
excludedSkus(optional):
array excludedSkus
The excluded SKU IDs
-
includedCategories(optional):
array includedCategories
The included categories
-
includedProducts(optional):
array includedProducts
The included products
-
includedSkus(optional):
array includedSkus
The included SKU IDs
Nested Schema : items
Type:
Show Source
object
-
discount_value(optional):
string
The discount value
-
spend_value(optional):
string
The spend value
Nested Schema : items
Type:
Show Source
object
-
message(optional):
string
Localizable text for the upsell message.
-
repositoryId(optional):
string
The message's ID.
-
tags(optional):
array tags
Array of message tags to use in associating where to display the message on the storefront.
Example Response (application/json)
{
"template":"/order/spendYGetOrderDiscount.pmdt",
"endDate":"2014-04-29T19:30:00.000-04:00",
"filterForQualifierZeroPrices":null,
"displayName":"10% Off Orders Over $100 ",
"templateValues":{
"spend_value":"100",
"discount_value":"10",
"discount_type_value":"percentOff",
"spend_close_value":"5.00"
},
"description":"Spend $100 today and get 10% off your order!",
"sites":[
{
"repositoryId":"funSite"
}
],
"global":false,
"type":9,
"enabled":true,
"cardIINRanges":[
"456789",
"9878",
"987634-987648"
],
"filterForQualifierNegativePrices":null,
"filterForQualifierOnSale":null,
"parentFolder":{
"repositoryId":"200002"
},
"audiences":[
{
"repositoryId":"audienceId1"
},
{
"repositoryId":"audienceId2"
}
],
"giveToAnonymousProfiles":false,
"filterForQualifierActedAsQualifier":null,
"shippingMethods":[
],
"closenessQualifiers":[
{
"closenessMessages":[
{
"message":"You're getting close! Buy {{QuantityStillNeeded}} more!",
"tags":[
{
"name":"Daily Deals"
},
{
"name":"Banner"
}
]
}
]
}
],
"priority":1,
"filterForQualifierDiscountedByAny":null,
"excludedPromotions":[
{
"repositoryId":"bogoPromotion"
},
{
"repositoryId":"explicitItemFixedDiscount"
}
],
"unqualifiedMessages":[
{
"message":"Buy something to qualify for this promotion.",
"tags":[
{
"name":"Banner"
}
]
}
],
"allowMultiple":false,
"qualifiedMessages":[
{
"message":"You have qualified for the promotion!",
"tags":[
{
"name":"Banner"
}
]
}
],
"uses":2,
"stackingRule":{
"maxPromotions":-1,
"displayName":"TEST2",
"repositoryId":"100002",
"id":"100002"
},
"maxUsesPerOrder":-1,
"startDate":"2014-04-25T17:30:00.000-04:00"
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|21001|Promotion Id is invalid.|
|21009|Internal Error.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code