Promotion

Represents a promotion for B2B or B2C stores. This object is available in API version 52.0 and later.

Supported Calls

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

Special Access Rules

Some of the fields on the Promotion object are available only if the B2B Commerce or B2B2C Commerce license is enabled.

Fields

Field	Details
AreQualItemsExclFromDiscounts	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Exclude qualifying items from discount. You can use this field to create buy-one-get-one promotions. The default value is `false`. This field is available in API version 56.0 and later.
CurrencyIsoCode	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
Description	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Description of the promotion.
DisplayName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Display name of the promotion.
EndDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when the promotion ends.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the promotion is active ('true') or inactive ('false'). The default value is 'false'.
IsAutomatic	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether the promotion is automatic or manual. If the promotion is automatic, it automatically applies to eligible carts without the buyer doing anything. if the promotion is manual, the buyer has to apply a coupon to redeem the promotion. The default value is 'false'.
IsCommercePromotion	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the promotion is a B2B Commerce promotion (true) or not (false). The default value is 'false'.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
MaximumUsageCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Maximum number of times the promotion can be applied to a cart. If left blank, the default value is 1. This field is available in API version 56.0 and later.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the promotion.
Objective	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Additional information, if any, about the purpose of the promotion.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who created the promotion. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
PriorityNumber	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Priority for the promotion. The priority determines which promotions apply first. The lower the number, the higher the priority.
QualifierCriteria	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If a promotion has multiple qualifiers, this field determines whether all qualifiers must be met or whether any must be met for the promotion to apply. Possible values are: `All` `Any` The default value is 'All'.
StartDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when the promotion begins.
TermsAndConditions	Type textarea Properties Create, Nillable, Update Description Terms and conditions the buyer accepts before applying the promotion.

Object Reference for the Salesforce Platform

Promotion

Supported Calls

Special Access Rules

Fields