Get Member Promotions

Retrieve a list of promotions that the member is eligible for, while asynchronously requesting data from the Get Member Promotions loyalty program process API.

Resource

Here’s the request when the input parameter is member ID.

1getPromotions(memberId:version:devMode:)

Signature

1public func getPromotions(
2    memberId: String,
3    version: String = LoyaltyAPIVersion.defaultVersion,
4    devMode: Bool = false) async throws -> PromotionModel

Here’s the request when the input parameter is membership number.

1getPromotions(memberNumber:version:devMode:)

Signature

1public func getPromotions(
2    membershipNumber: String,
3    version: String = LoyaltyAPIVersion.defaultVersion,
4    devMode: Bool = false) async throws -> PromotionModel

Input Parameters

Parameter	Types	Description	Required or Optional
`devMode`	Boolean	Indicates whether the request is run in developer mode (`(true)`) or not (`(false)`)..	Optional
`memberId`	String	Identifier of the member whose promotions are being retrieved.	Required
`membershipNumber`	String	The membership number of the member whose promotions are being retrieved.	Required
`version`	String	Version of the API. The request body is available in version 55.0 and later.	Optional

Sample Output

1{
2    "message": null,
3    "outputParameters": {
4        "outputParameters": {
5            "results": [
6                {
7                    "loyaltyPromotionType": "STANDARD",
8                    "maximumPromotionRewardValue": 0,
9                    "totalPromotionRewardPointsVal": 0,
10                    "loyaltyProgramCurrency": "0lc4x000000L1bmAAC",
11                    "memberEligibilityCategory": "Eligible",
12                    "promotionEnrollmentRqr": true,
13                    "fulfillmentAction": "CREDIT_POINTS",
14                    "promotionName": "Anniversary promotion",
15                    "promotionId": "0c84x000000CoNhAAK",
16                    "startDate": "2020-01-01",
17                    "endDate": "2022-12-31",
18                    "description": "Double point promotion on member purchases on their anniversary",
19                    "imageName": "offer2"
20                },
21                {
22                    "loyaltyPromotionType": "CUMULATIVE",
23                    "maximumPromotionRewardValue": 0,
24                    "totalPromotionRewardPointsVal": 200,
25                    "loyaltyProgramCurrency": "0lc4x000000L1bmAAC",
26                    "memberEligibilityCategory": "Eligible",
27                    "promotionEnrollmentRqr": false,
28                    "fulfillmentAction": "CREDIT_POINTS",
29                    "promotionName": "Referral Promotions",
30                    "promotionId": "0c84x000000CoNiAAK",
31                    "startDate": "2021-01-02",
32                    "description": "Additional points for member referral",
33                    "imageName": "promotion1"
34                },
35                {
36                    "promEnrollmentStartDate": "2022-11-01",
37                    "memberEligibilityCategory": "EligibleButNotEnrolled",
38                    "promotionEnrollmentEndDate": "2022-11-30",
39                    "promotionEnrollmentRqr": true,
40                    "promotionName": "New Year Promotion Premium",
41                    "promotionId": "0c84x000000CtzRAAS",
42                    "startDate": "2022-11-01",
43                    "description": "New Year Promotion Premium",
44                    "imageName": "meal1"
45                },
46                {
47                    "promEnrollmentStartDate": "2022-11-01",
48                    "memberEligibilityCategory": "Eligible",
49                    "promotionEnrollmentEndDate": "2022-11-30",
50                    "promotionEnrollmentRqr": true,
51                    "promotionName": "Christmas Promotion",
52                    "promotionId": "0c84x000020CtzWAAS",
53                    "startDate": "2022-12-01",
54                    "description": "Christmas Promotion - Happy holidays, enjoy a joyful holiday season with this promotion",
55                    "imageName": "promotion3"
56                },
57                {
58                    "loyaltyPromotionType": "STANDARD",
59                    "maximumPromotionRewardValue": 0,
60                    "totalPromotionRewardPointsVal": 0,
61                    "loyaltyProgramCurrency": "0lc4x000000L1bmAAC",
62                    "memberEligibilityCategory": "Eligible",
63                    "promotionEnrollmentRqr": true,
64                    "fulfillmentAction": "CREDIT_POINTS",
65                    "promotionName": "Anniversary promotion",
66                    "promotionId": "0c84x004000CoNhAAK",
67                    "startDate": "2020-01-01",
68                    "description": "Double point promotion on member purchases on their anniversary",
69                    "imageName": "offers"
70                },
71                {
72                    "loyaltyPromotionType": "CUMULATIVE",
73                    "maximumPromotionRewardValue": 0,
74                    "totalPromotionRewardPointsVal": 200,
75                    "loyaltyProgramCurrency": "0lc4x000000L1bmAAC",
76                    "memberEligibilityCategory": "Eligible",
77                    "promotionEnrollmentRqr": false,
78                    "fulfillmentAction": "CREDIT_POINTS",
79                    "promotionName": "Referral Promotions",
80                    "promotionId": "0c84x000006CoNiAAK",
81                    "startDate": "2021-01-02",
82                    "description": "Additional points for member referral",
83                    "imageName": "shoes1"
84                },
85                {
86                    "promEnrollmentStartDate": "2022-11-01",
87                    "memberEligibilityCategory": "EligibleButNotEnrolled",
88                    "promotionEnrollmentEndDate": "2022-11-30",
89                    "promotionEnrollmentRqr": true,
90                    "promotionName": "Thanksgiving Promotion Premium",
91                    "promotionId": "0c84x070000CtzRAAS",
92                    "startDate": "2022-11-01",
93                    "description": "Thanksgiving Promotion Premium",
94                    "imageName": "jean1"
95                },
96                {
97                    "promEnrollmentStartDate": "2022-11-01",
98                    "memberEligibilityCategory": "Ineligible",
99                    "promotionEnrollmentEndDate": "2022-11-30",
100                    "promotionEnrollmentRqr": true,
101                    "promotionName": "New Year Promotion Premium",
102                    "promotionId": "0c84x000000CtzWAAS",
103                    "startDate": "2022-11-01",
104                    "description": "New Year Promotion Premium - Ineligible",
105                    "imageName": "coffee1"
106                }
107            ]
108        }
109    },
110    "simulationDetails": {},
111    "status": true
112}

Output Parameters

Parameter	Type	Description
`description`	String	The description of the promotion.
`endDate`	String	The end date of the promotion.
`fulfillmentAction`	String	Specifies the fulfillment action of the related promotion. Possible values are: `Credit_Points` and `Issue_Voucher`
`imageName`	String	The name for the promotion image.
`loyaltyProgramCurrency`	String	The loyalty program currency associated with the promotion.
`loyaltyPromotionType`	String	The type of promotion. Possible values are `Cumulative`, `Standard`, or `Joint`.
`maximumPromotionRewardValue`	Double	The value that can be accumulated for the promotion.
`memberEligibilityCategory`	String	Specifies whether the loyalty program member is eligible for the promotion. Possible values are `Eligible`, `EligibleButNotEnrolled`, or `Ineligible`.
`message`	String	The request response message.
`promEnrollmentStartDate`	String	The date when the enrollment in the related promotion starts.
`promotionEnrollmentEndDate`	String	The date when the enrollment in the related promotion ends.
`promotionEnrollmentRqr`	Boolean	Indicates whether the related promotion requires member enrollment.
`promotionId`	String	The ID related to the promotion.
`promotionImageURL`	String	The URL for the promotion image. In the promotion record, enter an image URL and ensure that the webpage that hosts the image is publicly accessible.
`promotionName`	String	The name of the promotion.
`startDate`	String	The start date of the related promotion.
`status`	Boolean	Indicates whether the member is eligible to enroll for the promotion.
`totalPromotionRewardPointsVal`	Double	The total points credited to the loyalty program member for the related promotion.