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.

Fields

Field	Details
AdjustedLineAmount	Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of the OrderItemSummary.
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the OrderItemSummary.
EndDate	Type date Properties Filter, Group, Nillable, Sort Description End date of the OrderItemSummary.
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.
ListPrice	Type currency Properties Filter, Nillable, Sort Description List price of the product represented by this OrderItemSummary.
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, Sort Description ID of the original order item associated with this summary object.
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).
QuantityAllocated	Type double Properties Filter, Sort Description Allocated quantity on this order item summary. This quantity is associated with one or more FulfillmentOrderLineItems.
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.
QuantityFulfilled	Type double Properties Filter, Sort Description Fulfilled quantity on this OrderItemSummary. This quantity can no longer be canceled.
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.
QuantityReturnInitiated	Type double Properties Filter, Sort Description Quantity returned or pending return on this OrderItemSummary.
QuantityReturned	Type double Properties Filter, Sort Description Returned quantity on this OrderItemSummary.
ServiceDate	Type date Properties Filter, Group, Nillable, Sort Description Service or start date of the OrderItemSummary.
Status	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Status of the OrderItemSummary. Possible values are: `ALLOCATED` `CANCELED` `FULFILLED` `ORDERED` `PAID` `PARTIALLYALLOCATED` `PARTIALLYFULFILLED` `RESHIPPED` `RETURNED`
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.
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.
TotalAdjustmentDistTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentDistAmount.
TotalAdjustmentTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentAmount.
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.
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.
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)`
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`
UnitPrice	Type currency Properties Filter, Nillable, Sort Description Unit price of the product represented by the OrderItemSummary.

Object Reference for Salesforce and Lightning Platform

OrderItemSummary

Supported Calls

Special Access Rules

Fields

See Also