Newer Version Available

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

PriceAdjustmentSchedule

Represents a series of tiered discounts based on the number of items purchased. This object is available in API version 47.0 and later.

Supported Calls

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

Special Access Rules

This object is available only if the B2B Commerce license is enabled.

Fields

Field Details
AdjustmentMethod
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The method for applying tiered pricing. Possible values are:
  • Range—All items receive the discount of the highest tier the quantity falls in.
  • Slab—Items receive the discount defined for the tier they fall in.
The default value is Range. Term-based discounts can’t be of type Slab. This field is available in API version 51.0 and later.
Description
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Text description of the price adjustment schedule.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the price adjustment schedule is active (true) or not (false). You can change this field’s value as often as necessary. Label is Active. Default value is False.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Indicates whether the price adjustment schedule has been archived (true) or not (false). This field is read-only.
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
Create, Filter, Group, idLookup, Sort, Update
Description
Required. The name of the price adjustment schedule. This field is read-only. Label is Price Adjustment Schedule Name.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The Salesforce ID of the sales rep who owns the price adjustment schedule.

Usage

As you create a PriceAdjustmentSchedule, you associate PriceAdjustmentTiers with it. A PriceAdjustmentSchedule is inactive until at least one PriceAdjustmentTier is added to it. A PriceAdjustmentSchedule comprises all related PriceAdjustmentTiers, with a limit of 25.

To use PriceAdjustmentSchedule, associate it with a PriceBookEntry.
  • A PriceBookEntry can be associated with up to five PriceAdjustmentSchedules, but only one PriceAdjustmentSchedule can be associated with a PriceBookEntry.
  • When you activate or deactivate a PriceAdjustmentSchedule, its PriceBookEntry association is also activated or deactivated.
  • An adjustment to a PriceBookEntry is applied only if the associated PriceAdjustmentSchedule is active.
  • After a PriceAdjustmentSchedule is associated with a PriceBookEntry, if multicurrency is enabled, the currencyIsoCode field can’t be modified.
  • When you associate a PriceAdjustmentSchedule with a PricebookEntry, a junction object PricebookEntryAdjustment is created.

The PriceAdjustmentTier object and the ScheduleType and AdjustmentMethod fields can be modified only when a PriceAdjustmentSchedule is inactive.