Newer Version Available

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

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
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Description of 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
User-defined name of the order adjustment group.
OrderId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the order related to the adjustments in this order adjustment group.
RelatedAdjustmentGroupId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the original order’s adjustment group. Useful for reference in change order scenarios.
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
Shows the type of adjustment made.
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.