---
schema_version: "1"
id: cd2f70f34032f479978872381acea98a193d5557e07e01b86d0d5b85cfcdeb1a
title: OrderAdjustmentGroupSummary
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_orderadjustmentgroupsummary.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderadjustmentgroupsummary.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 5189047a4a12564cc1059e39c146172a1edbdffac8ae125ec798674fb3fee7a3
description: Represents the current properties and state of a group of related price adjustments. Associated with a set of OrderItemAdjustmentLineSummaries that apply to OrderItemSummaries belonging to one OrderSummary. Corresponds to one or more order adjustment group objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.
---
# OrderAdjustmentGroupSummary

Represents the current properties and state of a group of related price adjustments. Associated with a set of OrderItemAdjustmentLineSummaries that apply to OrderItemSummaries belonging to one OrderSummary. Corresponds to one or more order adjustment group objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.

An OrderAdjustmentGroupSummary can represent an adjustment to an entire order as a group of adjustments to each of its products. For example, representing “10% off the order” as a set of 10% off adjustments to each product on the order. It can also represent an adjustment that applies to a subset of the products on an order. For example, representing “buy one, get one 50% off” as a 25% off adjustment to each of two products.

## Supported Calls

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

## Special Access Rules

This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled.

## 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.



 |
| AdjustmentCauseId | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

References the specific promotions applied.

This is a polymorphic relationship field.

Relationship Name

AdjustmentCause

Relationship Type

Lookup

Refers To

Promotion

This field is available in API version 52.0 and later.



 |
| CurrencyIsoCode | 

Type

picklist

Properties

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

Description

ISO code for the currency of the OrderSummary associated with the adjustments in the group. The default value is USD.

Possible values are:

- DKK—Danish Krone
- EUR—Euro
- GBP—British Pound
- USD—U.S. Dollar

This field is available in API version 49.0 and later.



 |
| Description | 

Type

textarea

Properties

Create, Nillable, Update

Description

Description of the OrderAdjustmentGroupSummary.

This field can be edited.



 |
| GrandTotalAmount | 

Type

currency

Properties

Filter, Nillable, Sort

Description

Total, including tax, of the associated OrderItemAdjustmentLineSummaries.



 |
| Name | 

Type

string

Properties

Create, Filter, Group, idLookup, Sort, Update

Description

Name of the OrderAdjustmentGroupSummary.



 |
| OrderSummaryId | 

Type

reference

Properties

Filter, Group, Sort

Description

ID of the OrderSummary associated with the OrderAdjustmentGroupSummary.



 |
| OriginalOrderAdjGroupId | 

Type

reference

Properties

Filter, Group, Nillable, Sort

Description

ID of the original OrderAdjustmentGroup associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false.



 |
| TotalAmount | 

Type

currency

Properties

Filter, Nillable, Sort

Description

Total, not including tax, of the associated OrderItemAdjustmentIineSummaries.



 |
| TotalTaxAmount | 

Type

currency

Properties

Filter, Nillable, Sort

Description

Tax on the TotalAmount.



 |
| Type | 

Type

picklist

Properties

Filter, Group, Restricted picklist, Sort

Description

Type of the OrderAdjustmentGroupSummary. Header represents an order-level adjustment with an OrderItemAdjustmentLineSummary for each OrderItemSummary on the OrderSummary. SplitLine represents any other related set of OrderItemAdjustmentLineSummaries.

Possible values are:

- Header
- SplitLine

If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field.



 |

## 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.

[OrderAdjustmentGroupSummaryChangeEvent](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.") (API version 62.0)

Change events are available for the object.

#### See Also

- [OrderAdjustmentGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderadjustmentgroup.htm "Group containing a set of adjustments applied to an order. This object is available in API version 48.0 and later.")
- [OrderItemAdjustmentLineSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemadjustmentlinesummary.htm "Represents the current properties and state of price adjustments on an OrderItemSummary. Corresponds to one or more order item adjustment line item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.")