Skip Navigation

PriceAdjustmentGroup

Defines the business logic for a top-level price adjustment, for example, a discount applied to an entire order. This object interface is available in API version 55.0 and later.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

This object interface is available with Subscription Management or B2B Commerce.

Fields

Field	Details
AdjustmentSource	Type: picklist Properties: Filter, Restricted picklist, Sort Description: Indicates the source of the adjustment. This field is available with B2B Commerce. Possible values are: `Discretionary`—The adjustment is entered manually, for example, by a sales rep. `Promotion`—The adjustment is part of a promotion. `Rule`—Reserved for future use. `System`—The adjustment is configured by the system data, for example, as part of a pricing rule or discount schedule.
AdjustmentType	Type: picklist Properties: Filter, Restricted picklist, Sort Description: Indicates whether the adjustment is a percentage, an amount, or an override. Possible values are: `AdjustmentAmount`—Reserved for future use. `AdjustmentPercentage` `OverrideAmount`
AdjustmentValue	Type: double Properties: Filter, Sort Description: The value of the adjustment. To indicate a discount, use a negative number.
Description	Type: textarea Properties: Nillable Description: User-entered description of the price adjustment group. Available in API versions 55.0 to 57.0.
ImplementorType	Type: string Properties: Filter, Group, Nillable, Sort Description: The object that is implementing this entity interface, for example, a WebCartAdjustmentGroup object.
PriceAdjustmentCauseId	Type: reference Properties: Filter, Nillable, Sort Description: The ID of the record that is the source of the adjustment. For example, if the price adjustment is due to a promotion, this field contains the ID of the promotion record. If the price adjustment is due to a price adjustment tier, this field contains the ID of the price adjustment tier record. This field is a relationship field. Relationship Name: PriceAdjustmentCause Relationship Type: Lookup Refers To: PriceAdjCauseInterface
Priority	Type: int Properties: Filter, Nillable, Sort Description: A positive integer indicating the order in which this price adjustment group is applied, relative to other price adjustment groups. A Priority of `1` indicates this price adjustment group is applied first. Price adjustments with a null priority are applied after price adjustments with a specified priority. If two or more price adjustments have a null priority, percentage adjustments are applied before amount adjustments. Applying a percentage adjustment before an amount adjustment results in a larger total adjustment. The value of Priority must be unique among price adjustment groups in the same sales transaction.
SalesTransactionId	Type: reference Properties: Filter, Group, Nillable, Sort Description: The ID of the sales transaction that the price adjustment group belongs to. This field is a relationship field. Relationship Name: SalesTransaction Relationship Type: Lookup Refers To: SalesTransaction
TotalAmount	Type: currency Properties: Filter, Sort Description: The total amount of adjustments of all related price adjustment items, inclusive of quantity, prorated for the duration of the subscription. This field is a calculated field equal to the sum of the TotalAmount fields in the related price adjustment items.