Promotion

Represents a promotion for B2B or D2C stores.

Introduced in API version 46.0.

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

  • Some of the fields on the Promotion object are available only if the B2B Commerce or D2C Commerce license is enabled.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 56.0
  • Description: Exclude qualifying items from discount. You can use this field to create buy-one-get-one promotions. The default value is false.
  • Default value: false

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 68.0

  • Relationship name: Brief

  • Relationship type: relationship

  • Refers to: Brief

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Relationship name: Campaign

  • Relationship type: relationship

  • Refers to: Campaign

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Description of the promotion.

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 56.0

  • Description:

    Indicates whether to apply discounts first to the least expensive products or to the most expensive products.

    The default value is MostExpensive.

  • Possible values:

    • LeastExpensive — LeastExpensive
    • MostExpensive — MostExpensive (default)

  • Default value: MostExpensive

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 56.0

  • Description:

    Indicates whether to restrict the products that can be discounted based on the least expensive qualifying product.

    The default value is None.

  • Possible values:

    • LeastExpensive — LeastExpensive
    • None — None (default)

  • Default value: None

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Description: Display name of the promotion.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Description: Date and time when the promotion ends.

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 58.0

  • Description:

    Determines whether a promotion can be combined with other promotions.

    The default value is Class.

  • Possible values:

    • No — No — Can be combined with other promotions.
    • Class — Class (default) — Can’t be combined with a promotion of the same class (product, order, or shipment), but allows for promotions of separate classes to be combined. For example, an order discount on top of a product discount.
    • Global — Global — Only promotion that can be applied to the order, regardless of class.

  • Default value: Class

  • 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.

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort

  • Introduced: API version 64.0

  • Description:

    Indicates that the promotion shows an approaching discount message. Set an approaching discount threshold value on the PromotionQualifier object.

    The default value is false.

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 52.0

  • Description:

    Determines whether the promotion is automatic or manual. If the promotion is automatic, it automatically applies to eligible carts with no buyer action required. if the promotion is manual, the buyer applies a coupon to redeem the promotion.

    The default value is false.

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 52.0

  • Description:

    Indicates if the promotion is a B2B Commerce promotion (true) or not (false).

    The default value is false.

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 60.0

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort

  • Introduced: API version 57.0

  • Description:

    Indicates whether the promotion uses promotion tiers (true) or not (false). This value can’t be changed.

    The default value is false.

    A tiered promotion can have up to 10 associated tiers.

  • Default value: false

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Description: Maximum number of times the promotion can be applied to a cart. If left blank, the default value is 1.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the promotion.
  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: More information, if any, about the purpose of the promotion.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Description: Priority for the promotion. The priority determines which promotions apply first. The lower the number, the higher the priority.

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 53.0

  • 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.

    The default value is ‘All’.

  • Possible values:

    • All — All
    • Any — Any

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 60.0

  • Relationship name: RuleSet

  • Relationship type: relationship

  • Refers to: Ruleset

  • Type: date
  • Properties: Create, Filter, Group, Sort, Update
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Description: Date and time when the promotion begins.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 56.0
  • Description: If a promotion has multiple targets, indicates whether a cart must meet the criteria for any target or the criteria for all targets.
  • Possible values:
    • All — All
    • Any — Any
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Introduced: API version 53.0
  • Description: Terms and conditions the buyer accepts before applying the promotion.

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.