Promotion
Represents a promotion for B2B or D2C stores. This object is available in API version 52.0 and later.
This guide only lists certain information for each object. For more information, including descriptions of the fields, see Promotion in the Consumer Goods Cloud Developer Guide, Loyalty Management Developer Guide, Object Reference for the Salesforce Platform, and Referral Marketing Developer Guide.
| Field Name | Field Label | Type | Digits | Length | Precision | Scale |
|---|---|---|---|---|---|---|
AreQualItemsExclFromDiscounts | Exclude qualifying items from discounts | boolean | ||||
BusinessUnitId | Internal Organization Unit ID | reference | 18 | |||
CampaignId | Campaign ID | reference | 18 | |||
CreatedById | Created By ID | reference | 18 | |||
CreatedDate | Created Date | datetime | ||||
CumulativeUsageTarget | Cumulative Usage Target | int | 9 | |||
CurrencyIsoCode | Currency ISO Code | picklist | 3 | |||
CurrentLiabilityAmount | Current Liability Amount | currency | 18 | 2 | ||
CurrentPointCount | Current Point Count | int | 9 | |||
DefaultVoucherDefinitionId | Voucher Definition ID | reference | 18 | |||
Description | Description | textarea | 1000 | |||
DiscountOrder | Discount Order | picklist | 255 | |||
DiscountRestriction | Discount Restriction | picklist | 255 | |||
DisplayName | Display Name | string | 255 | |||
EndDate | End Date | date | ||||
EndDateTime | End Datetime | datetime | ||||
EnrollmentEndDate | Enrollment End Date | date | ||||
EnrollmentStartDate | Enrollment Start Date | date | ||||
ExclusivityType | Exclusivity Type | picklist | 255 | |||
FulfillmentAction | Fulfillment Action | picklist | 255 | |||
GameDefinitionId | Game Definition ID | reference | 18 | |||
Id | Promotion ID | id | 18 | |||
ImageUrl | Image URL | url | 1000 | |||
IsActive | Active | boolean | ||||
IsApproachingDiscountApplicable | Approaching Discount | boolean | ||||
IsAutomatic | Automatic | boolean | ||||
IsCloned | Cloned | boolean | ||||
IsCommercePromotion | Commerce Promotion | boolean | ||||
IsDeleted | Deleted | boolean | ||||
IsEnrollmentRequired | Enrollment Required | boolean | ||||
IsPointsWithFactor | Points With Factor | boolean | ||||
IsQualCriteriaNotRequiredPerApplication | Qualifying Criteria Not Required Per Application | boolean | ||||
IsQuickPromotion | Quick Promotion | boolean | ||||
IsReferralPromotion | Referral Promotion | boolean | ||||
IsTiered | Tiered Promotion | boolean | ||||
IssuedVoucherCount | Issued Voucher Count | int | 9 | |||
LastModifiedById | Last Modified By ID | reference | 18 | |||
LastModifiedDate | Last Modified Date | datetime | ||||
LastReferencedDate | Last Referenced Date | datetime | ||||
LastViewedDate | Last Viewed Date | datetime | ||||
LoyaltyProgramCurrencyId | Currency ID | reference | 18 | |||
LoyaltyProgramId | Loyalty Program ID | reference | 18 | |||
LoyaltyPromotionType | Loyalty Promotion Type | picklist | 255 | |||
MaximumLiabilityAmount | Maximum Liability Amount | currency | 18 | 2 | ||
MaximumRewardValue | Maximum Reward Value | int | 9 | |||
MaximumUsageCount | Maximum Applications Per Cart | int | 9 | |||
MaximumVoucherCount | Maximum Voucher Count | int | 9 | |||
Name | Name | string | 255 | |||
Objective | Objective | textarea | 1000 | |||
OwnerId | Owner ID | reference | 18 | |||
PersonalizationType | Personalization Type | picklist | 255 | |||
PointFactor | Point Factor | double | 18 | 0 | ||
PriorityNumber | Priority Number | int | 9 | |||
PromotionCode | Promotion Code | string | 255 | |||
PromotionConfiguration | Promotion Configuration | textarea | 131072 | |||
PromotionPageUrl | Promotion Page URL | url | 1000 | |||
PromotionTemplateId | Promotion Template ID | reference | 18 | |||
QualifierCriteria | Qualifier Criteria | picklist | 255 | |||
ReferralType | Referral Type | picklist | 40 | |||
RelatedPromotionId | Promotion ID | reference | 18 | |||
RelatedReferralProgramId | Loyalty Program ID | reference | 18 | |||
StartDate | Start Date | date | ||||
StartDateTime | Start Datetime | datetime | ||||
Status | Status | picklist | 255 | |||
SystemModstamp | System Modstamp | datetime | ||||
TargetCriteria | Target Criteria | picklist | 255 | |||
TermsAndConditions | Terms and Conditions | textarea | 4000 | |||
TotalRewardPoints | Reward Points | int | 9 | |||
TransactionJournalType | Transaction Journal Type | picklist | 255 | |||
UsageType | Usage Type | picklist | 255 |
Feed tracking for Promotion.
This guide only lists certain information for each object. For more information, including descriptions of the fields, see StandardObjectNameFeed in the Object Reference for the Salesforce Platform.
| Field Name | Field Label | Type | Digits | Length | Precision | Scale |
|---|---|---|---|---|---|---|
BestCommentId | Best Comment ID | reference | 18 | |||
Body | Body | textarea | 10000 | |||
CommentCount | Comment Count | int | 9 | |||
CreatedById | Created By ID | reference | 18 | |||
CreatedDate | Created Date | datetime | ||||
Id | Feed Item ID | id | 18 | |||
InsertedById | InsertedBy ID | reference | 18 | |||
IsDeleted | Deleted | boolean | ||||
IsRichText | Is Rich Text | boolean | ||||
LastModifiedDate | Last Modified Date | datetime | ||||
LikeCount | Like Count | int | 9 | |||
LinkUrl | Link URL | url | 1000 | |||
NetworkScope | Network Scope | picklist | 40 | |||
ParentId | Parent ID | reference | 18 | |||
RelatedRecordId | Related Record ID | reference | 18 | |||
SystemModstamp | System Modstamp | datetime | ||||
Title | Title | string | 255 | |||
Type | Feed Item Type | picklist | 40 | |||
Visibility | Visibility | picklist | 40 |
History for tracked fields of Promotion.
This guide only lists certain information for each object. For more information, including descriptions of the fields, see StandardObjectNameHistory in the Object Reference for the Salesforce Platform.
| Field Name | Field Label | Type | Digits | Length | Precision | Scale |
|---|---|---|---|---|---|---|
CreatedById | Created By ID | reference | 18 | |||
CreatedDate | Created Date | datetime | ||||
DataType | Datatype | picklist | 40 | |||
Field | Changed Field | picklist | 255 | |||
Id | Promotion History ID | id | 18 | |||
IsDeleted | Deleted | boolean | ||||
NewValue | New Value | anyType | 255 | |||
OldValue | Old Value | anyType | 255 | |||
PromotionId | Promotion ID | reference | 18 |
Sharing for Promotion.
This guide only lists certain information for each object. For more information, including descriptions of the fields, see StandardObjectNameShare in the Object Reference for the Salesforce Platform.
| Field Name | Field Label | Type | Digits | Length | Precision | Scale |
|---|---|---|---|---|---|---|
AccessLevel | Custom Object Access | picklist | 40 | |||
Id | Custom Object Share ID | id | 18 | |||
IsDeleted | Deleted | boolean | ||||
LastModifiedById | Last Modified By ID | reference | 18 | |||
LastModifiedDate | Last Modified Date | datetime | ||||
ParentId | Parent ID | reference | 18 | |||
RowCause | Row Cause | picklist | 40 | |||
UserOrGroupId | User/Group ID | reference | 18 |