get https://{host}/api_gateway/v1/promotions/customer/109943742?includeRedemptions=true&includeSupplementaryPromotions=true
This API is used to retrieve the cart promotions tagged to a particular customer based on the user ID. This returns cart promotions issued to the customer or POS promotions which are tagged to the customer's tier or supplementary programs.
Response Parameters
| Parameter | Data type | Description |
|---|---|---|
| promotionId | String | Unique identifier of the Cart promotion |
| promotionName | String | Name of the Cart promotion |
| validTill | Long | Expiration timestamp (milliseconds since epoch) |
| customerId | Long | Unique Identifier of the Customer using the Cart promotion |
| earnedType | String | The method how cart promotion was earned. Supported values: NONE, TIER, REWARD, LOYALTY. None: Promotion is directly assigned to the customer, no qualification criteria required. Tier: Promotion is assigned based on the customers loyalty tier or status level, no qualifying action is required. Reward: Promotion is earned on the basis of completing a milestone or achievement, action is required. Loyalty: Promotion is tied to loyalty program. |
| earnedStatus | String | Status of the earned cart promotion. Supported Values: LOCKED, UNLOCKED, EXPIRED. Locked: Promotion has been Issued but not yet available to use. Unlocked: Promotion is active and ready for the customer to use. Expired: Promotion was available before but cannot be used now. |
| promotionStatus | String | Promotion can have three statues: ACTIVE, INACTIVE, EXPIRED. Active - The cart promotion is currently running and if all conditions are met it can be used by the customer. However, it does not reflects whether the promotion has been redeemed by the customer. For example, A birthday promotion is running for an entire month so the status will show ACTIVE throughout, does not means whether the customer can use the promotion or not. To check whether the customer can use promotion check remainingRedemtion. Inactive - Promotion exists in the system but is currently deactivated, could be due to manual deactivation by administrator. Expired - Promotion's end date is over and it's no longer running. |
| mileStoneId | Long | Milestone or achievement target linked to the promotion |
| targetGroupId | Long | Identifier for a specific customer group eligible for the promotion based on predefined criteria. It indicates the offer was specifically designed for a customer segment. |
| applicationMode | String | Indicates the way the promotion is applied. Supported Values: DISCOUNT, REWARD. Discount: Promotion applies to reduce the price, lowering the amount customer pays at checkout. Reward: It provides benefit or reward that does not applies at transaction. |
| customFieldValues | Object | Contains custom key-value pairs related to the promotion |
| restrictions | Object | Contains restrictions categorized by level. To get this response, set query parameter includeRedemptions to true. |
| - Cart | Array | Contains cart-level restrictions applicable to the promotion. |
| -- kpi | String | Indicates the key performance metric used for restriction. |
| -- maxLimit | String | Indicates the maximum allowed limit for a specific restriction. For Example, In the birthday offer the maxLimit would be set to 1 so the customer can only redeem the promotion once while it is running. |
| -- remainingRedemption | String | Indicates the remaining number of times the cart promotion can be used by the customer. If the count is zero, it means that the promotion cannot be used by the customer. For Example, In a birthday offer if the promotion is already used to maxLimit by the customer and remainingRedemtion is 0 then even if promotionStatus is ACTIVE, the customer cannot use the promotion again. |
| eventTime | Long | Timestamp of the event that triggered the cart promotion (milliseconds since epoch) |
| supplementaryCriteria | Object | Defines additional loyalty based conditions. To get this response, set query parameter includeSupplementaryRedemtion to true |
| - loyaltyprogramId | Long | Identifier of the loyalty program associated with cart promotion |
| - programType | Enum | Indicates the type of program |
| - partnerprogramId | Long | Indicates partner program Id, if it is a partner program |