Newer Version Available

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

OrderItemAdjustmentLineItem

An adjustment that has been made to an order item. 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.
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.
Amount
Type
currency
Properties
Create, Filter, Sort, Update
Description
The total value of the adjustment line.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Users can add a custom description to the record to provide additional detail.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the adjustment line.
OrderAdjustmentGroupId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The order adjustment group that contains the order item adjustment line item.
OrderId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The parent order of the the order item related to the adjustment line.
OrderItemId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The order item that the adjustment line applies to.
RelatedAdjustmentLineItemId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The original order item adjustment line. Useful for reference in change order scenarios.
TotalAmtWithTax
Type
currency
Properties
Filter, Nillable, Sort
Description
Equals TotalPrice + TotalTaxAmount for the order item adjustment line item.
This is a gross tax field.
To access Commerce Orders fields, your org must have a Salesforce Order Management license. Commerce Orders fields are available only in Lightning Experience.
This field is available in API v49.0 and later.
TotalTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount of tax applied to the adjustment line.