OrderItemSummary

Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order 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.

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 on Lightning Experience license is enabled.

Fields

Field	Details
AdjustedLineAmount	Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of the OrderItemSummary.
AdjustedLineAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total price of the OrderItemSummary, inclusive of adjustments and tax. This amount is equal to AdjustedLineAmount + TotalAdjustedLineTaxAmount. This field is available in API version 49.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 OrderItemSummary. 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 string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the OrderItemSummary. This field can be edited.
EndDate	Type date Properties Filter, Group, Nillable, Sort Description End date of the OrderItemSummary. 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.
GrossUnitPrice	Type currency Properties Filter, Nillable, Sort Description Unit price, including tax, of the OrderItemSummary. This value is equal to UnitPrice + the amount of tax on the UnitPrice. 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. This field is available in API version 49.0 and later.
LineNumber	Type int Properties Filter, Group, Nillable, Sort Description The order line number assigned to this OrderItemSummary. For example, if this object is the third in the displayed list of OrderItemSummaries belonging to the OrderSummary, this value is 3. 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.
ListPrice	Type currency Properties Filter, Nillable, Sort Description List price of the product represented by this OrderItemSummary. 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.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderItemSummary.
OrderDeliveryGroupSummaryId	Type reference Properties Filter, Group, Sort Description ID of the OrderDeliveryGroupSummary to which this object belongs.
OrderSummaryId	Type reference Properties Filter, Group, Sort Description ID of the OrderSummary to which this object belongs.
OriginalOrderItemId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the original order item associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false.
Product2Id	Type reference Properties Filter, Group, Sort Description ID of the product represented by this OrderItemSummary.
ProductCode	Type string Properties Filter, Group, Nillable, Sort Description Product code of the product represented by this OrderItemSummary.
Quantity	Type double Properties Filter, Sort Description Current total quantity of products represented by this order item summary. Equal to QuantityOrdered minus (QuantityCanceled and QuantityReturned). 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.
QuantityAllocated	Type double Properties Filter, Sort Description Allocated quantity on this order item summary. This quantity is associated with one or more FulfillmentOrderLineItems. 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.
QuantityAvailableToCancel	Type double Properties Filter, Nillable, Sort Description Quantity that can still be canceled on this OrderItemSummary. Equal to QuantityOrdered minus (QuantityCanceled and QuantityAllocated). This value duplicates QuantityAvailableToFulfill.
QuantityAvailableToFulfill	Type double Properties Filter, Nillable, Sort Description Quantity available to be fulfilled on this OrderItemSummary. Equal to QuantityOrdered minus (QuantityCanceled and QuantityAllocated). This value duplicates QuantityAvailableToCancel.
QuantityAvailableToReturn	Type double Properties Filter, Nillable, Sort Description Quantity available to be returned on this OrderItemSummary. Equal to QuantityFulfilled minus QuantityReturnInitiated.
QuantityCanceled	Type double Properties Filter, Sort Description Canceled quantity on this OrderItemSummary. 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.
QuantityFulfilled	Type double Properties Filter, Sort Description Fulfilled quantity on this OrderItemSummary. This quantity can no longer be canceled. 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.
QuantityNetOrdered	Type double Properties Filter, Nillable, Sort Description Quantity available to be allocated on this OrderItemSummary. Equal to QuantityOrdered minus QuantityCanceled.
QuantityOrdered	Type double Properties Filter, Sort Description Ordered quantity on this OrderItemSummary. It includes the originally ordered quantity plus any quantity added to the order later. 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.
QuantityReturned	Type double Properties Filter, Sort Description Returned quantity on this OrderItemSummary. 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.
QuantityReturnInitiated	Type double Properties Filter, Sort Description Quantity returned or pending return on this OrderItemSummary. 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.
QuantityShipped	Type double Properties Filter, Nillable, Sort, Update Description Quantity shipped on this OrderItemSummary. This field is available in API version 52.0 and later.
ReservedAtLocationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for future use.
ServiceDate	Type date Properties Filter, Group, Nillable, Sort Description Service or start date of the OrderItemSummary. 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.
Status	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Status of the OrderItemSummary. The default value is ORDERED. Possible values are: `ALLOCATED`—Allocated `CANCELED`—Canceled `FULFILLED`—Fulfilled `ORDERED`—Ordered `PAID`—Paid `PARTIALLYALLOCATED`—Partially Allocated `PARTIALLYFULFILLED`—Partially Fulfilled `RESHIPPED`—Reshipped `RETURNED`—Returned `RETURNINITIATED`—Return Initiated
StockKeepingUnit	Type string Properties Filter, Group, Nillable, Sort Description The stock keeping unit (SKU) of the Product2 associated with the OrderItemSummary.. This field is available in API version 49.0 and later.
TotalAdjustedLineTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the AdjustedLineAmount.
TotalAdjustmentAmount	Type currency Properties Filter, Nillable, Sort Description Total of all price adjustments applied to this OrderItemSummary.
TotalAdjustmentAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total amount of all price adjustments applied to this OrderItemSummary, inclusive of tax. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount. This field is available in API version 49.0 and later.
TotalAdjustmentDistAmount	Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to this OrderItemSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header.
TotalAdjustmentDistAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total amount of the order-level price adjustments applied to this OrderItemSummary, inclusive of tax. This amount is equal to TotalAdjustmentDistAmount + TotalAdjustmentDistTaxAmount. This field is available in API version 49.0 and later.
TotalAdjustmentDistTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentDistAmount.
TotalAdjustmentTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentAmount.
TotalAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total price of the OrderItemSummary, inclusive of tax. This amount is equal to TotalPrice + TotalTaxAmount. This field is available in API version 49.0 and later.
TotalLineAdjustmentAmount	Type currency Properties Filter, Nillable, Sort Description Total of all non-order-level price adjustments applied to this OrderItemSummary. This value includes OrderItemAdjustmentLineSummaries that don’t belong to an OrderAdjustmentGroupSummary, or that belong to an OrderAdjustmentGroupSummary of type SplitLine.
TotalLineAdjustmentAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total of all non-order-level price adjustments applied to this OrderItemSummary, inclusive of tax. This amount is equal to TotalLineAdjustmentAmount + TotalLineAdjustmentTaxAmount. This field is available in API version 49.0 and later.
TotalLineAdjustmentTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalLineAdjustmentAmount.
TotalLineAmount	Type currency Properties Filter, Nillable, Sort Description Total, not including adjustments or tax, of the OrderItemSummary. 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.
TotalLineAmountWithTax	Type currency Properties Filter, Nillable, Sort Description Total unadjusted amount of the OrderItemSummary, inclusive of tax. This amount is equal to TotalLineAmount + TotalLineTaxAmount. This field is available in API version 49.0 and later.
TotalLineTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalLineAmount.
TotalPrice	Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of the OrderItemSummary.
TotalTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalPrice.
Type	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of the OrderItemSummary. Delivery Charge indicates that the OrderItemSummary represents a delivery charge. Order Product indicates that it represents any other type of product, service, or charge. Each type corresponds to one type code, shown here in parentheses. Possible values are: `Delivery Charge (Charge)` `Order Product (Product)` 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.
TypeCode	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type code of the OrderItemSummary. Charge indicates that the OrderItemSummary represents a delivery charge. Product indicates that it represents any other type of product, service, or charge. Possible values are: `Charge` `Product` 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.
UnitPrice	Type currency Properties Filter, Nillable, Sort Description Unit price of the product represented by the OrderItemSummary. 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.

Object Reference for Salesforce and Lightning Platform

OrderItemSummary

Supported Calls

Special Access Rules

Fields

See Also