PromotionPartyUsage

Represents the details of number of times a promotion has been used by a customer. This object is available in API version 60.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

PromotionPartyUsage is only available in orgs where Global Promotions Management is enabled. In addition, to track member-level promotion usage for Loyalty, the org feature Track Member Progress for Engagement Trails Using Promotion Party Usage must be enabled. Without this setting, UsageCount is not updated when transaction journals are processed.

Fields

Field	Details
AccountId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the account associated with the organization that has used the promotion. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account
AdditionalAttributeInfo	Type textarea Properties Create, Nillable, Update Description Specifies the details of the additional promotional attribute for Contact, Account or a member in JSON format.
ContactId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the contact associated with the person who has used the promotion. This field is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact
EnrollmentEffectiveDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time at which the customer enrolled in the promotion.
EnrollmentExpirationDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time until which the customer stays enrolled in the promotion.
EnrollmentOfferId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The offer through which the customer enrolled in the promotion. This field is a relationship field. Relationship Name EnrollmentOffer Refers To Offer
IssuedVoucherCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of vouchers that have been issued to the customer as the associated promotion’s reward.
IsPartyEnrolled	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the customer is enrolled in the promotion (true) or not (false). The default value is `false`.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record.
LoyaltyProgramMemberId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the loyalty program member who has used the promotion. This field is a relationship field. Relationship Name LoyaltyProgramMember Relationship Type Lookup Refers To LoyaltyProgramMember
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The autogenerated unique number of the record.
OrderCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of orders for which the customer has applied the promotion.
PartyId	Type reference Properties Create, Filter, Group, Sort Description ID of the person or the organization that has been provided the discount. This field is a polymorphic relationship field. Relationship Name Party Relationship Type Lookup Refers To Account, Contact, LoyaltyProgramMember
PointsCredited	Type double Properties Create, Filter, Nillable, Sort, Update Description The number of points that have been credited to a loyalty program member as the associated promotion’s reward.
PromotionId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the promotion for which the customer’s usage is tracked. This field is a relationship field. Relationship Name Promotion Relationship Type Lookup Refers To Promotion
Type	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The type of customer for whom the promotion usage is tracked. Possible values are: `Account` `Contact` `LoyaltyProgramMember`
UsageCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The number of times a party has used a promotion. This value is checked against the corresponding PromotionLimit.Value when the Eligible Promotions List (POST) resource is called. If UsageCount equals or exceeds the limit, the promotion is excluded from the eligible promotions response and is not applied to subsequent transactions.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

PromotionPartyUsageFeed: Feed tracking is available for the object.
PromotionPartyUsageHistory: History is available for tracked fields of the object.

Loyalty Management Developer Guide

PromotionPartyUsage

Supported Calls

Special Access Rules

Fields

Associated Objects