Newer Version Available

This content describes an older version of this product. View Latest

PromotionTarget

Represents the product, product category, or order that you want to target with your promotion in B2B Commerce. 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 PromotionTarget object is available only if the B2B Commerce license is enabled.

Fields

Field Details
AdjustmentAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The promotion discount expressed as an amount, not as a percentage.
AdjustmentPercent
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
The percentage discount of the promotion. Valid values include numbers from 1–100.
AdjustmentType
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 are:
  • FixedAmountOffLineItemTotal—Fixed amount off the total of all line items.
  • FixedAmountOffUnitPrice—Fixed amount off the unit price.
  • PercentageDiscount—Percentage discount.
CurrencyIsoCode
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
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.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the promotion target.
PromotionId
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
Lookup
Refers To
Promotion
TargetId
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
Lookup
Refers To
Product2, ProductCategory
TargetProductCategoryName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product category referenced in the target. This field is available in API version 55.0 and later.
TargetProductName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product referenced in the target. This field is available in API version 55.0 and later.
TargetProductSku
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The stock keeping unit of the product referenced in the target. This field is available in API version 55.0 and later.
TargetType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The target of the promotion. Product applies the promotion to a single product, ProductCategory to a predetermined group of products, and Transaction to the entire order.
Possible values are:
  • Product
  • ProductCategory
  • Transaction