Promotion Configuration Output

Output representation of the promotion’s details and its configuration.
JSON Example
{
    "apiExecutedDateTime": "2024-05-29T09:02:38.809Z",
    "promotionDetails": {
        "additionalFieldValues": {
            "attributes": {}
        },
        "displayName": "Tea Time",
        "endDateTime": "2024-07-31T08:58:00.000Z",
        "name": "Tea Time",
        "priorityNumber": 1,
        "promotionCode": "TEATIME",
        "promotionLimits": {},
        "startDateTime": "2024-05-01T08:58:00.000Z"
    },
    "promotionLastModifiedDateTime": "2024-05-29T09:01:51.000Z",
    "promotionRuleList": [
        {
            "apiName": "Eligibility_Rule_Unified_Promotions_0c8xx000000034L",
            "isEligibilityRule": true,
            "name": "Eligibility_Rule_Unified_Promotions_0c8xx000000034L_v1",
            "ruleActionList": [],
            "ruleFilterCriteriaList": [
                {
                    "conditionLogic": "1",
                    "name": "FilterCriteria1",
                    "ruleActionList": [],
                    "ruleConditionList": [
                        {
                            "operator": "Equals",
                            "parameterName": "CurrencyISOCode",
                            "sequenceNumber": 1,
                            "valueList": [
                                "USD"
                            ],
                            "valueType": "Literal"
                        }
                    ],
                    "sequenceNumber": 1,
                    "type": "Exists"
                },
                {
                    "conditionLogic": "1 AND 2",
                    "name": "FilterCriteria2",
                    "parentFilterCriteria": "FilterCriteria1",
                    "ruleActionList": [],
                    "ruleConditionList": [
                        {
                            "operator": "GreaterThanOrEquals",
                            "parameterName": "ActivityStartDateTime",
                            "sequenceNumber": 1,
                            "valueList": [
                                "2024-05-01 08:58:00"
                            ],
                            "valueType": "Literal"
                        },
                        {
                            "operator": "LessThanOrEquals",
                            "parameterName": "ActivityStartDateTime",
                            "sequenceNumber": 2,
                            "valueList": [
                                "2024-07-31 08:58:00"
                            ],
                            "valueType": "Literal"
                        }
                    ],
                    "sequenceNumber": 2,
                    "type": "Exists"
                },
                {
                    "conditionLogic": "1 AND 2",
                    "name": "FilterCriteria3",
                    "parentFilterCriteria": "FilterCriteria2",
                    "ruleActionList": [],
                    "ruleConditionList": [
                        {
                            "operator": "Equals",
                            "parameterName": "ProductCatalog",
                            "sequenceNumber": 1,
                            "valueList": [
                                "Beverages"
                            ],
                            "valueType": "Literal"
                        },
                        {
                            "operator": "In",
                            "parameterName": "EligibleCartLineProduct",
                            "sequenceNumber": 2,
                            "valueList": [
                                "Tea"
                            ],
                            "valueType": "Literal"
                        }
                    ],
                    "sequenceNumber": 3,
                    "type": "Exists"
                }
            ],
            "ruleParameterList": [
                {
                    "contextTag": "cartLineProductCatalogId",
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": true,
                    "isCollection": true,
                    "isInput": true,
                    "isOutput": false,
                    "name": "ProductCatalog",
                    "type": "Tag"
                },
                {
                    "contextTag": "activityStartDate",
                    "dataType": "DateTime",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": true,
                    "isCollection": true,
                    "isInput": true,
                    "isOutput": false,
                    "name": "ActivityStartDateTime",
                    "type": "Tag"
                },
                {
                    "contextTag": "currencyISOCode",
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": true,
                    "isCollection": true,
                    "isInput": true,
                    "isOutput": false,
                    "name": "CurrencyISOCode",
                    "type": "Tag"
                },
                {
                    "contextTag": "cartLineProductId",
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": true,
                    "isCollection": true,
                    "isInput": true,
                    "isOutput": false,
                    "name": "EligibleCartLineProduct",
                    "type": "Tag"
                }
            ],
            "sequenceNumber": 2147483647
        },
        {
            "apiName": "DiscountTea10Unified_Promotions_0c8xx000000034L",
            "isEligibilityRule": false,
            "name": "DiscountTea10Unified_Promotions_0c8xx000000034L_v1",
            "ruleActionList": [],
            "ruleFilterCriteriaList": [
                {
                    "conditionLogic": "1",
                    "name": "FinalFilterCriteria",
                    "ruleActionList": [],
                    "ruleConditionList": [
                        {
                            "operator": "GreaterThanOrEquals",
                            "parameterName": "TransactionAmount",
                            "sequenceNumber": 1,
                            "valueList": [
                                "25.0"
                            ],
                            "valueType": "Literal"
                        }
                    ],
                    "sequenceNumber": 1,
                    "type": "Exists"
                },
                {
                    "conditionLogic": "1",
                    "name": "NonLoyaltyMemberCriteria",
                    "parentFilterCriteria": "BranchCriteria",
                    "ruleActionList": [
                        {
                            "actionType": "SetValue",
                            "name": "pricingReward1",
                            "ruleActionParameterList": [
                                {
                                    "name": "type",
                                    "sequenceNumber": 1,
                                    "value": "ProvideDiscount",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountLevel",
                                    "sequenceNumber": 2,
                                    "value": "Cart",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountValue",
                                    "sequenceNumber": 3,
                                    "value": "10.0",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountType",
                                    "sequenceNumber": 4,
                                    "value": "PercentageOff",
                                    "valueType": "Literal"
                                }
                            ],
                            "sequenceNumber": 1
                        }
                    ],
                    "ruleConditionList": [
                        {
                            "operator": "GreaterThanOrEquals",
                            "parameterName": "ActivityStartDateTime",
                            "sequenceNumber": 1,
                            "valueList": [
                                "1970-01-01 08:00:00"
                            ],
                            "valueType": "Literal"
                        }
                    ],
                    "sequenceNumber": 3,
                    "type": "Exists"
                },
                {
                    "name": "BranchCriteria",
                    "parentFilterCriteria": "FinalFilterCriteria",
                    "ruleActionList": [],
                    "ruleConditionList": [],
                    "sequenceNumber": 2,
                    "type": "Branch"
                }
            ],
            "ruleParameterList": [
                {
                    "contextTag": "transactionAmount",
                    "dataType": "Currency",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": true,
                    "isCollection": true,
                    "isInput": true,
                    "isOutput": false,
                    "name": "TransactionAmount",
                    "type": "Tag"
                },
                {
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "discountLevel",
                    "type": "Variable"
                },
                {
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "discountType",
                    "type": "Variable"
                },
                {
                    "contextTag": "activityStartDate",
                    "dataType": "DateTime",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": true,
                    "isCollection": true,
                    "isInput": true,
                    "isOutput": false,
                    "name": "ActivityStartDateTime",
                    "type": "Tag"
                },
                {
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "type",
                    "type": "Variable"
                },
                {
                    "dataType": "Numeric",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "discountValue",
                    "type": "Variable"
                }
            ],
            "sequenceNumber": 1
        },
        {
            "apiName": "TeaAndCoffeeDiscount10Unified_Promotions_0c8xx000000034L",
            "isEligibilityRule": false,
            "name": "TeaAndCoffeeDiscount10Unified_Promotions_0c8xx000000034L_v1",
            "ruleActionList": [],
            "ruleFilterCriteriaList": [
                {
                    "conditionLogic": "1",
                    "name": "NonLoyaltyMemberCriteria",
                    "parentFilterCriteria": "BranchCriteria",
                    "ruleActionList": [
                        {
                            "actionType": "SetValue",
                            "name": "pricingLineLevelReward1",
                            "ruleActionParameterList": [
                                {
                                    "name": "type",
                                    "sequenceNumber": 1,
                                    "value": "ProvideDiscount",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountType",
                                    "sequenceNumber": 2,
                                    "value": "PercentageOff",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountLevel",
                                    "sequenceNumber": 3,
                                    "value": "Line",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountValue",
                                    "sequenceNumber": 4,
                                    "value": "10.0",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountProduct",
                                    "sequenceNumber": 5,
                                    "value": "Tea",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountProductId",
                                    "sequenceNumber": 6,
                                    "value": "Tea",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountAppliedAt",
                                    "sequenceNumber": 7,
                                    "value": "LineItem",
                                    "valueType": "Literal"
                                }
                            ],
                            "sequenceNumber": 1
                        },
                        {
                            "actionType": "SetValue",
                            "name": "pricingLineLevelReward2",
                            "ruleActionParameterList": [
                                {
                                    "name": "type",
                                    "sequenceNumber": 1,
                                    "value": "ProvideDiscount",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountType",
                                    "sequenceNumber": 2,
                                    "value": "PercentageOff",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountLevel",
                                    "sequenceNumber": 3,
                                    "value": "Line",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountValue",
                                    "sequenceNumber": 4,
                                    "value": "10.0",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountProduct",
                                    "sequenceNumber": 5,
                                    "value": "Coffee",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountProductId",
                                    "sequenceNumber": 6,
                                    "value": "Coffee",
                                    "valueType": "Literal"
                                },
                                {
                                    "name": "discountAppliedAt",
                                    "sequenceNumber": 7,
                                    "value": "LineItem",
                                    "valueType": "Literal"
                                }
                            ],
                            "sequenceNumber": 2
                        }
                    ],
                    "ruleConditionList": [
                        {
                            "operator": "GreaterThanOrEquals",
                            "parameterName": "ActivityStartDateTime",
                            "sequenceNumber": 1,
                            "valueList": [
                                "1970-01-01 08:00:00"
                            ],
                            "valueType": "Literal"
                        }
                    ],
                    "sequenceNumber": 4,
                    "type": "Exists"
                },
                {
                    "conditionLogic": "1",
                    "name": "ProductFilter1",
                    "ruleActionList": [],
                    "ruleConditionList": [
                        {
                            "operator": "In",
                            "parameterName": "CartLineProduct",
                            "sequenceNumber": 1,
                            "valueList": [
                                "Tea"
                            ],
                            "valueType": "Literal"
                        }
                    ],
                    "sequenceNumber": 1,
                    "type": "Loop"
                },
                {
                    "name": "BranchCriteria",
                    "parentFilterCriteria": "FinalFilterCriteria",
                    "ruleActionList": [],
                    "ruleConditionList": [],
                    "sequenceNumber": 3,
                    "type": "Branch"
                },
                {
                    "conditionLogic": "1",
                    "name": "FinalFilterCriteria",
                    "ruleActionList": [],
                    "ruleConditionList": [
                        {
                            "matchType": "Any",
                            "operator": "GreaterThanOrEquals",
                            "parameterName": "FilterProducts1",
                            "sequenceNumber": 1,
                            "valueList": [
                                "6.0"
                            ],
                            "valueType": "Literal"
                        }
                    ],
                    "sequenceNumber": 2,
                    "type": "Exists"
                }
            ],
            "ruleParameterList": [
                {
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "discountLevel",
                    "type": "Variable"
                },
                {
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "discountProduct",
                    "type": "Variable"
                },
                {
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "discountProductId",
                    "type": "Variable"
                },
                {
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "discountType",
                    "type": "Variable"
                },
                {
                    "contextTag": "activityStartDate",
                    "dataType": "DateTime",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": true,
                    "isCollection": true,
                    "isInput": true,
                    "isOutput": false,
                    "name": "ActivityStartDateTime",
                    "type": "Tag"
                },
                {
                    "contextTag": "cartLineProductId",
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": true,
                    "isCollection": true,
                    "isInput": true,
                    "isOutput": false,
                    "name": "CartLineProduct",
                    "type": "Tag"
                },
                {
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "type",
                    "type": "Variable"
                },
                {
                    "dataType": "Numeric",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "discountValue",
                    "type": "Variable"
                },
                {
                    "aggregateFunction": "Sum",
                    "dataType": "Tuple",
                    "decimalPlaces": 0,
                    "groupByContextTag": "cartLineProductId",
                    "hasContextTagMapping": true,
                    "isCollection": true,
                    "isInput": true,
                    "isOutput": true,
                    "name": "FilterProducts1",
                    "relatedFilterCriteriaName": "ProductFilter1",
                    "type": "Accumulate",
                    "value": "cartLineItemQuantity"
                },
                {
                    "dataType": "Text",
                    "decimalPlaces": 0,
                    "hasContextTagMapping": false,
                    "isCollection": false,
                    "isInput": false,
                    "isOutput": true,
                    "name": "discountAppliedAt",
                    "type": "Variable"
                }
            ],
            "sequenceNumber": 2
        }
    ],
    "relatedRuleLibrary": {
        "apiName": "GPMRuleLibrary",
        "description": "GPMRuleLibrary",
        "name": "GPMRuleLibrary_v1",
        "relatedContextDefinitionDeveloperName": "GPMContext"
    }
}
Table 1. Promotion Configuration Output
Property Name Type Description Filter Group and Version Available Version
apiExecutedDateTime String The date and time on which the API was executed. Small, 61.0 61.0
promotionDetails Promotion Details [] The details of the promotion. Small, 61.0 61.0
promotionLastModifiedDateTime String The date and time on which the promotion was last modified. Small, 61.0 61.0
promotionRuleList Promotion Rule List [] The rules of the promotion. The rules are represented as context rules in the response. Small, 61.0 61.0
relatedRuleLibrary Rule Library [] The rule library that's associated with the promotion. Small, 61.0 61.0
Table 2. Promotion Details Output
Property Name Type Description Filter Group and Version Available Version
name String The name of the promotion. Small, 61.0 61.0
objective String The objective of the promotion. Small, 61.0 61.0
priorityNumber String The priority number of the promotion. Small, 61.0 61.0
startDateTime String The date and time from when the promotion can be applied for customers. Small, 61.0 61.0
endDateTime String The date and time until the promotion can be applied for customers. Small, 61.0 61.0
description String The description of the promotion. Small, 61.0 61.0
additionalFieldValues Additonal Attributes [] The details of the promotion's additional fields. Small, 61.0 61.0
promotionCode String The code of the promotion. Small, 61.0 61.0
currencyIsoCode String Three-letter ISO 4217 code currency associated with the promotion. Small, 61.0 61.0
Table 3. Promotion Additional Attributes Output
Property Name Type Description Filter Group and Version Available Version
attributes Map<String,String> The additional attributes of the promotion. Small, 61.0 61.0
Table 4. Rule Library Output
Property Name Type Description Filter Group and Version Available Version
name String The name of the rule library associated with the promotion. Small, 61.0 61.0
apiName String The API name of the rule library associated with the promotion. Small, 61.0 61.0
description String The description of the rule library associated with the promotion. Small, 61.0 61.0
relatedContextDefinitionDeveloperName String The developer name of the context definition associated with the promotion's rule library. Small, 61.0 61.0
Table 5. Promotion Rule Output
Property Name Type Description Filter Group and Version Available Version
name String The name of the promotion rule. A promotion consists of two types of rules. The eligibility rule decides which products, categories, stores, store groups, and customers are eligible for the promotion. The template rules decide which customer activities are eligible for the promotion and the rewards available for each eligible customer activity. Small, 61.0 61.0
description String The description of the promotion rule. Small, 61.0 61.0
apiName String The API name of the promotion rule. Small, 61.0 61.0
isEligibilityRule Boolean Indicates whether the rule is the promotion eligibility rule (true) or not (false). Small, 61.0 61.0
sequenceNumber Integer The sequence number of the rule in the promotion rules list. Small, 61.0 61.0
ruleFilterCriteriaList Rule Filter Criteria List [] The list of filter criteria that belong to the rule. Small, 61.0 61.0
ruleActionList Rule Action List [] The list of actions that belong to the rule. Small, 61.0 61.0
ruleParameterList Rule Parameter List [] The list of parameters that belong to the rule. Small, 61.0 61.0
Table 6. Rule Filter Criteria Output
Property Name Type Description Filter Group and Version Available Version
name String The name of the promotion rule's filter criteria. Small, 61.0 61.0
type String The type of promotion rule filter criteria. Small, 61.0 61.0
conditionLogic String The condition logic of the promotion rule's filter criteria. Small, 61.0 61.0
sequenceNumber Integer The sequence number of the promotion rule's filter criteria in the promotion rule. Small, 61.0 61.0
parentFilterCriteria String The parent filter criteria that the promotion rule filter criteria belongs to. Small, 61.0 61.0
ruleConditionList Rule Condition List [] The list of conditions that belong to the promotion rule filter criteria. Small, 61.0 61.0
ruleActionList Rule Action List [] The list of actions that belong to the promotion rule filter criteria. Small, 61.0 61.0
Table 7. Rule Condition Output
Property Name Type Description Filter Group and Version Available Version
parameterName String The name of the parameter that's used to define the rule filter criteria condition. Small, 61.0 61.0
operator String The operator of the rule filter criteria condition. Small, 61.0 61.0
valueList Map<String,String> The value that the rule filter criteria checks the parameter against. Small, 61.0 61.0
valueType String The type of value. Small, 61.0 61.0
sequenceNumber Integer The sequence number of the rule filter criteria condition in the rule condition list. Small, 61.0 61.0
matchType String Specifies whether the condition qualifies as true when all the values in the value list match the condition's requirements or when any one of the values in the value list match the condition's requirements. Small, 61.0 61.0
Table 8. Rule Action Output
Property Name Type Description Filter Group and Version Available Version
name String The name of the action associated with either a promotion rule or a promotion rule criteria. Small, 61.0 61.0
sequenceNumber Integer The sequence number of the action in either a promotion rule or a promotion rule criteria. Small, 61.0 61.0
actionType String The type of promotion rule action. Small, 61.0 61.0
ruleActionParameterList Rule Action Parameter List [] The list of action parameters that belong to the rule or criteria action. Small, 61.0 61.0
Table 9. Rule Action Parameter Output
Property Name Type Description Filter Group and Version Available Version
name String The name of the parameter associated with the promotion rule action. Small, 61.0 61.0
value String The value of the promotion rule action parameter. Small, 61.0 61.0
sequenceNumber Integer The sequence number of the promotion rule action parameter. Small, 61.0 61.0
valueType String The type of value. Small, 61.0 61.0
relatedFilterCriteriaName String The name of the rule filter criteria associated with the rule action parameter. Small, 61.0 61.0
Table 10. Rule Parameter Output
Property Name Type Description Filter Group and Version Available Version
name String The name of the parameter associated with the rule. Small, 61.0 61.0
dataType String The data type of the rule parameter. Small, 61.0 61.0
type String The type of rule parameter. Small, 61.0 61.0
decimalPlaces Integer The number of decimal places supported by a numeric type rule parameter. Small, 61.0 61.0
value String The value of the rule parameter. Small, 61.0 61.0
isInput Boolean Indicates whether the parameter stores a value that's used to process the rule (true) or not (false). Small, 61.0 61.0
isOutput Boolean Indicates whether the parameter stores a value that's provided after the rule is processed (true) or not (false). Small, 61.0 61.0
isCollection Boolean Indicates whether the parameter stores a list of comma-separated values (true) or not (false). Small, 61.0 61.0
contextTag String The context tag that is used in the rule parameter.The context tag belongs to the context definition associated with the promotion's rule library. Small, 61.0 61.0
hasContextTagMapping Boolean Indicates whether the context tag has a corresponding context tag mapping (true) or not (false).The context mapping is available in the active version of the rule library associated with the promotion. Small, 61.0 61.0
aggregateFunction String The aggregate function that's used in the rule parameter. Small, 61.0 61.0
groupByContextTag String The customer activity inputs are grouped by the context tag. Small, 61.0 61.0
relatedFilterCriteriaName String The name of the rule filter criteria associated with the rule parameter. Small, 61.0 61.0