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.

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

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

ParameterTypesDescriptionRequired or Optional
devModeBooleanIndicates whether the request is run in developer mode ((true)) or not ((false))..Optional
memberIdStringIdentifier of the member whose promotions are being retrieved.Required
membershipNumberStringThe membership number of the member whose promotions are being retrieved.Required
versionStringVersion of the API. The request body is available in version 55.0 and later.Optional
ParameterTypeDescription
descriptionStringThe description of the promotion.
endDateStringThe end date of the promotion.
fulfillmentActionStringSpecifies the fulfillment action of the related promotion. Possible values are: Credit_Points and Issue_Voucher
imageNameStringThe name for the promotion image.
loyaltyProgramCurrencyStringThe loyalty program currency associated with the promotion.
loyaltyPromotionTypeStringThe type of promotion. Possible values are Cumulative, Standard, or Joint.
maximumPromotionRewardValueDoubleThe value that can be accumulated for the promotion.
memberEligibilityCategoryStringSpecifies whether the loyalty program member is eligible for the promotion. Possible values are Eligible, EligibleButNotEnrolled, or Ineligible.
messageStringThe request response message.
promEnrollmentStartDateStringThe date when the enrollment in the related promotion starts.
promotionEnrollmentEndDateStringThe date when the enrollment in the related promotion ends.
promotionEnrollmentRqrBooleanIndicates whether the related promotion requires member enrollment.
promotionIdStringThe ID related to the promotion.
promotionImageURLStringThe 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.
promotionNameStringThe name of the promotion.
startDateStringThe start date of the related promotion.
statusBooleanIndicates whether the member is eligible to enroll for the promotion.
totalPromotionRewardPointsValDoubleThe total points credited to the loyalty program member for the related promotion.