PromotionQualifier

Represents the product, product category, or order that you want to target with your promotion qualifier in a B2B or D2C store. This object is available in API version 52.0 and later.

Supported Calls

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

Special Access Rules

The PromotionQualifier object is available only if the B2B Commerce or D2C Commerce license is enabled.

Fields

Field Details
ApproachingDiscountThreshold
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount that a customer has to reach before seeing an approaching discount message.
For example, if a promotion qualifier minimum is set at $150 and this field is set at $50, then a customer receives a banner notification that they're approaching the discount when they have at least $50 in their cart. This field is available in API version 64.0 and later.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, 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.
ExternalQualifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A qualifying product or product category stored outside of Salesforce. This field is available in API version 56.0 and later.

This field is available through the API only.

Note

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.
MinimumAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum dollar amount that a buyer must purchase to qualify for the promotion.
MinimumQuantity
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum quantity that a buyer must purchase to qualify for the promotion.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Name of the promotion qualifier.
PromotionId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the promotion that you want to associate with your promotion qualifier.
This is a relationship field.
Relationship Name
Promotion
Relationship Type
Lookup
Refers To
Promotion
PromotionTierId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the promotion tier associated with the qualifier. Only used with tiered promotions.
This is a relationship field.
This field is available in API version 57.0 and later.
Relationship Name
PromotionTier
Relationship Type
Lookup
Refers To
PromotionTier
QualifierId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the qualifier.
This is a polymorphic relationship field.
Relationship Name
Qualifier
Relationship Type
Lookup
Refers To
Product2, ProductCategory
QualifierOperator
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Possible values are:
  • EQUAL_TO
  • NONE
  • NOT_EQUAL_TO
QualifierProductCategoryName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product category referenced in the qualifier. This field is available in API version 55.0 and later.
QualifierProductName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product referenced in the qualifier. This field is available in API version 55.0 and later.
QualifierProductSku
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The stock keeping unit of the product referenced in the qualifier. This field is available in API version 55.0 and later.
QualifierRuleCriteriaType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of qualifier rule criteria.
Possible values are:
  • All
  • Any
QualifierType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of qualifier that you want to add to the promotion. Product applies the qualifier to a single product, ProductCategory to a predetermined group of products, and TransactionTotal to the entire order.
Possible values are:
  • Product
  • ProductCategory
  • TransactionTotal

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.

PromotionQualifierFeed
Feed tracking is available for the object.
PromotionQualifierHistory
History is available for tracked fields of the object.