LoyaltyPgmMbrPromEligView

Represents a virtual object that provides a consolidated view of the loyalty program member’s eligibility for a promotion and their enrollment status in eligible promotions. This object is available in API version 56.0 and later.

Supported Calls

create(), describeSObjects(), query()

LoyaltyPgmMbrPromEligView isn’t available in the Object Manager and can’t be customized.

Fields

CurrPromotionLiabilityAmt

Type: currency

Properties: Create, Filter, Nillable, Sort

Description: The current liability amount of the related promotion.

CurrencyIsoCode

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort

Description: The currency ISO code of the promotion. This field is only available in orgs where multiple currencies are enabled.

Possible values are:

USD—U.S. Dollar

The default value is USD.

CurrentPromotionPointsCount

Type: int

Properties: Create, Filter, Group, Nillable, Sort

Description: The liability amount incurred for the related promotion till date.

DefaultVoucherDefinitionId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The voucher definition that’s used as the default in the related promotion.

This field is a relationship field.

Relationship Name: DefaultVoucherDefinition

Relationship Type: Lookup

Refers To: VoucherDefinition

Description

Type: textarea

Properties: Create, Filter, Nillable, Sort

Description: The description of the LoyaltyPgmMbrPromEligView record.

DoesPromHavePtWithFctr

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort

Description: Indicates whether the related promotion has a point with factor.

The default value is false.

EndDate

Type: date

Properties: Create, Filter, Group, Nillable, Sort

Description: The end date of the related promotion.

EndDateTime

Type: dateTime

Properties: Create, Filter, Nillable, Sort

Description: End date and time of the promotion.

ExternalId

Type: string

Properties: Create, Filter, Group, Nillable, Sort

Description: A combination of the related loyalty program member ID and the related promotion ID.

FulfillmentAction

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort

Description: Specifies the fulfillment action of the related promotion.

Possible values are:

CreditPoints
IssueVoucher

IsMbrEligBsdCmpnOrSgmt

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort

Description: Indicates if the member who is eligible for a promotion is part of a campaign or segment.

The default value is false.

IsPromotionEnrollmentRqr

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort

Description: Indicates whether the related promotion requires member enrollment.

The default value is false.

IssuedPromotionVoucherCount

Type: int

Properties: Create, Filter, Group, Nillable, Sort

Description: The number of vouchers issued for the related promotion.

LoyaltyProgramCurrencyId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The loyalty program currency that’s used to credit points for the related promotion.

This field is a relationship field.

Relationship Name: LoyaltyProgramCurrency

Relationship Type: Lookup

Refers To: LoyaltyProgramCurrency

LoyaltyProgramId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The loyalty program that’s associated with the related promotion.

This field is a relationship field.

Relationship Name: LoyaltyProgram

Relationship Type: Lookup

Refers To: LoyaltyProgram

LoyaltyProgramMemberId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The loyalty program member associated with the related promotion.

This field is a relationship field.

Relationship Name: LoyaltyProgramMember

Relationship Type: Lookup

Refers To: LoyaltyProgramMember

LoyaltyPromotionType

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort

Description: Specifies the type of the related promotion.

Possible values are:

Cumulative
Joint
Standard

MaxPromotionLiabilityAmount

Type: currency

Properties: Create, Filter, Nillable, Sort

Description: The maximum liability amount that the related promotion can incur.

MaxPromotionVoucherCount

Type: int

Properties: Create, Filter, Group, Nillable, Sort

Description: The maximum vouchers that can be issued for the related promotion.

MaximumPromotionRewardValue

Type: int

Properties: Create, Filter, Group, Nillable, Sort

Description: The maximum reward value of the related promotion.

MemberEligibilityCategory

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort

Description: Specifies whether the loyalty program member is eligible for the promotion.

Possible values are:

Eligible
EligibleButNotEnrolled
Ineligible

Objective

Type: textarea

Properties: Create, Filter, Nillable, Sort

Description: The objective of the related promotion.

PromEnrollmentStartDate

Type: date

Properties: Create, Filter, Group, Nillable, Sort

Description: The date when the enrollment in the related promotion starts.

PromotionCumulativeUsageTgt

Type: int

Properties: Create, Filter, Group, Nillable, Sort

Description: The cumulative usage target of the related promotion.

PromotionEnrollmentEndDate

Type: date

Properties: Create, Filter, Group, Nillable, Sort

Description: The date when the enrollment in the related promotion ends.

PromotionId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The promotion related to the promotion related to the LoyaltyPgmMbrPromEligView record.

This field is a relationship field.

Relationship Name: Promotion

Relationship Type: Lookup

Refers To: Promotion

PromotionImageUrl

Type: url

Properties: Create, Filter, Group, Nillable, Sort

Description: The URL of the promotion’s image location. This field is available in API version 58.0 and later.

PromotionName

Type: string

Properties: Create, Filter, Group, Nillable, Sort

Description: The name of the related promotion.

PromotionPointFactor

Type: double

Properties: Create, Filter, Nillable, Sort

Description: The points factor of the related promotion.

PromotionTrxnJournalType

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort

Description: The transaction journal type that’s associated with the related promotion.

Possible values are:

Accrual
Redemption

StartDate

Type: date

Properties: Create, Filter, Group, Sort

Description: Required. The start date of the related promotion.

StartDateTime

Type: dateTime

Properties: Create, Filter, Nillable, Sort

Description: The start date and time of the promotion.

TotalPromotionRewardPointsVal

Type: int

Properties: Create, Filter, Group, Nillable, Sort

Description: The total points credited to the loyalty program member for the related promotion.