PromotionLimit

Represents the limit of a promotion. 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

PromotionLimit is only available in orgs where Global Promotions Management is enabled.

Promotion limits on this object are enforced only through a two-step API flow: first call Eligible Promotions List (POST), which checks PromotionPartyUsage.UsageCount against the configured limit and filters out ineligible promotions; then pass the returned eligible promotions as appliedPromotions in Transaction Journals Execution. If transaction journals are created directly without applied promotions, promotion limits aren’t enforced.

Note

Fields

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.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The autogenerated unique number of the record.

PromotionId

Type: reference
Properties: Create, Filter, Group, Sort
Description: ID of the promotion that the limit is for.

This field is a relationship field.
Relationship Name: Promotion
Relationship Type: Lookup
Refers To: Promotion

Type

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Required. The type of promotion limit.
Possible values:
- CartItemCount
- FinancialLiability
- OrderCount
- TotalUsage
- UsagePerCustomer
- VouchersIssued
- Milestone

Value

Type: double
Properties: Create, Filter, Sort, Update
Description: Required. The value of the promotion limit.

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.

PromotionLimitFeed: Feed tracking is available for the object.
PromotionLimitHistory: History is available for tracked fields of the object.