PromotionTarget

Represents the product, product category, or order that you want to target with your promotion in a B2B Store or D2C store.

Introduced in API version 52.0.

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

  • The PromotionTarget object is available only if the B2B Commerce or D2C Commerce license is enabled.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Description: The promotion discount is expressed as an amount, not as a percentage.
  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The percentage discount of the promotion. Valid values include numbers from 1 through 100.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The type of adjustment discount applied to the product or group of products.
  • Possible values:
    • FixedAmountOffLineItemTotal — FixedAmountOffLineItemTotal — Fixed amount off the total of all line items.
    • FixedAmountOffTransaction — FixedAmountOffTransaction — Fixed amount off the entire transaction. This value is available in API version 56.0 and later.
    • FixedAmountOffUnitPrice — FixedAmountOffUnitPrice — Fixed amount off the unit price.
    • FixedPrice — FixedPrice — Fixed price for a product. This value is available in API version 56.0 and later.
    • TotalFixedPrice — TotalFixedPrice — Fixed price for a set number of products. Requires a quantity limit. This value is available in API version 56.0 and later.
    • PercentageDiscount — PercentageDiscount — Percentage discount.
    • BonusProduct — BonusProduct — Gift product at no additional cost after qualifying purchases. This value is available in API version 64.0 and later.

  • Type: boolean

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

  • Introduced: API version 67.0

  • Default value: false

  • Type: string

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

  • Introduced: API version 56.0

  • Description: A target product or product category stored outside of Salesforce.

    This field is available through the API only.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 56.0
  • Description: If true, the max value in the RestrictionQuantity field must be met before the promotion is applied. The default value is false.
  • Default value: false
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The name of the promotion target.

  • Type: reference

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

  • Introduced: API version 68.0

  • Relationship name: ProductSellingModel

  • Relationship type: relationship

  • Refers to: ProductSellingModel

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    The ID of the promotion that you want to reference.

    This is a relationship field.

  • Relationship name: Promotion

  • Relationship type: masterdetail

  • Refers to: Promotion

  • Type: reference

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

  • Introduced: API version 57.0

  • Description:

    The ID of the promotion tier associated with the target. Only used with tiered promotions.

    This is a relationship field.

  • Relationship name: PromotionTier

  • Relationship type: relationship

  • Refers to: PromotionTier

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 56.0
  • Description: Maximum number of times the discount can be applied to the target.

  • Type: reference

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

  • Description:

    The ID of the product or product category that you want to target.

    This is a polymorphic relationship field.

  • Relationship name: Target

  • Relationship type: polymorphic

  • Refers to: Product2, ProductCategory, StandardShippingRate

  • Type: picklist

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

  • Introduced: API version 59.0

  • Description:

    For product and category targets, specify if the qualifying product or item in the qualifying category must be in the cart to determine if the cart satisfies the promotions criteria. For example, a quantity or amount across one or more items.

    Possible values are:

    • EQUAL_TO—Specifies that the qualifying product or item in the qualifying category must be in the cart.
    • NOT_EQUAL_TO—Specifies that the qualifying product or item in the qualifying category isn’t required to be in the cart.
    • NONE—Specifies that none of the other possible values apply. If the target type is for an order, you must use none.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The name of the product category referenced in the target.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The name of the product referenced in the target.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The stock keeping unit of the product referenced in the target.

  • Type: picklist

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

  • Introduced: API version 59.0

  • Description:

    Controls what promotion rules must be met for the promotion to be valid.

    Possible values are:

    • ALL—Specifies that all of the promotion rules must be met.
    • ANY—Specifies that any of the promotion rules can be met.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 62.0
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The target of the promotion.
  • Possible values:
    • Product — Product — Applies the promotion to a single product.
    • ProductCategory — ProductCategory — Applies the promotion to a group of products.
    • Shipping — Shipping — Applies the promotion to all shipping methods on the order.
    • StandardShippingRate — StandardShippingRate — Applies the promotion to a single shipping method on the order.
    • Transaction — Transaction — Applies the promotion to the entire order.

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.