---
schema_version: "1"
id: eaf614bb3f7c8b88478cc17192ea531a03780124f51102a4cf3438675354a8bc
title: OrderAdjustmentGroup
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_orderadjustmentgroup.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderadjustmentgroup.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6a04f7d9df3988235c0c38e3d33586afb792eb14eace56736cb04e510246c834
description: Group containing a set of adjustments applied to an order. This object is available in API version 48.0 and later.
---
# OrderAdjustmentGroup

Group containing a set of adjustments applied to an order. This object is available in API version 48.0 and later.

## Supported Calls

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

## Special Access Rules

To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience.

## Fields

| Field | Details |
| --- | --- |
| AdjustmentBasisReferenceId | 
Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

References the specific coupon applied.

This is a polymorphic relationship field.

Relationship Name

AdjustmentBasisReference

Relationship Type

Lookup

Refers To

Coupon

This field is available in API version 54.0 and later.

This field can only refer to Coupon when B2B Commerce is enabled.



 |
| AdjustmentCauseId | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

References the specific promotions applied.

This field is a polymorphic relationship field.

Relationship Name

AdjustmentCause

Relationship Type

Lookup

Refers To

PriceAdjustmentTier, Promotion

This field is available in API version 52.0 and later.

This field can only refer to Promotion when B2B Commerce is enabled.



 |
| AdjustmentSource | 

Type

picklist

Properties

Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description

Indicates the origin of the adjustment.

Possible values are:

- Discretionary—The adjustment originates from a decision made by an individual, for example, a manager’s discount granted to a client.
- Promotion—The adjustment originates from a promotion, for example, a holiday sale discount.
- Rule—Reserved for future use.
- System—The adjustment originates from the system, for example, a volume discount after the amount of items reaches a specific number.

This field is available in API version 57.0 and later.



 |
| AdjustmentType | 

Type

picklist

Properties

Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description

Indicates the type of mathematical adjustment to be applied to the order.

Possible values are:

- AdjustmentAmount—The adjustment is a numerical amount, for example, a cash discount of 20.
- AdjustmentPercentage—The adjustment is a percentage amount, for example, a 10% discount.
- OverrideAmount—The adjustment is a manual price override.

This field is available in API version 57.0 and later.



 |
| AdjustmentValue | 

Type

double

Properties

Create, Filter, Nillable, Sort, Update

Description

The specified AdjustmentType’s amount to be applied to the order.

For example, when the AdjustmentType value is AdjustmentAmount, the AdjustmentValue is expected to equal the value of the TotalAmount field.

When the AdjustmentType value is AdjustmentPercentage, the AdjustmentValue represents the percentage number, and the TotalAmount field’s value will show the calculated adjustment amount.

This field is available in API version 57.0 and later.



 |
| CurrencyIsoCode | 

Type

picklist

Properties

Defaulted on create, Filter, Group, Restricted picklist, Sort

Description

The currency used for the checkout session. Default value is USD.

Possible values are:

- USD—U.S. Dollar





 |
| Description | 

Type

textarea

Properties

Create, Nillable, Update

Description

User-entered information about the order adjustment group.



 |
| GrandTotalAmount | 

Type

currency

Properties

Filter, Nillable, Sort

Description

The sum of all total amounts of all adjustments in this group, including tax.



 |
| Name | 

Type

string

Properties

Create, Filter, Group, idLookup, Sort, Update

Description

The user-defined name of the order adjustment group.



 |
| OrderId | 

Type

reference

Properties

Create, Filter, Group, Sort

Description

The unique identifier of the order related to the adjustments in this order adjustment group.

This field is a relationship field.

Relationship Name

Order

Relationship Type

Lookup

Refers To

Order



 |
| Priority | 

Type

int

Properties

Create, Filter, Group, Nillable, Sort

Description

A numeric value that represents the order of precedence of the order adjustment group.

It can also represent the order of precedence when applying the AdjustmentType values. For example, an order can have two adjustments: a $100 discount and a 10% discount. This field will tell the pricing engine which adjustment needs to be applied first.

This field is available in API version 57.0 and later.



 |
| RelatedAdjustmentGroupId | 

Type

reference

Properties

Filter, Group, Nillable, Sort

Description

The unique identifier of the original order’s adjustment group. This field is a useful reference in change order scenarios.

This field is a relationship field.

Relationship Name

RelatedAdjustmentGroup

Relationship Type

Lookup

Refers To

OrderAdjustmentGroup



 |
| TotalAmount | 

Type

currency

Properties

Filter, Nillable, Sort

Description

The total of all order adjustments in this order adjustment group, excluding tax.



 |
| TotalTaxAmount | 

Type

currency

Properties

Filter, Nillable, Sort

Description

The total tax for all order adjustments in this order adjustment group.



 |
| Type | 

Type

picklist

Properties

Create, Filter, Group, Restricted picklist, Sort, Update

Description

Indicates how the adjustment was applied to the order.

Possible values are:

- Header: — The adjustment was applied to the order’s balance, and then distributed among the order products in the adjustment group.
- SplitLine— The adjustment was applied to order product balances for the order products in the adjustment group.





 |

## Associated Objects

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 and later.

[OrderAdjustmentGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.")

Change events are available for the object.

[OrderAdjustmentGroupFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")

Feed tracking is available for the object.

[OrderAdjustmentGroupHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")

History is available for tracked fields of the object.

[OrderAdjustmentGroupOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.")

Sharing rules are available for the object.

[OrderAdjustmentGroupShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")

Sharing is available for the object.