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.

Introduced in API version 48.0.

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

  • This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total, including line adjustments but not order-lever adjustments or tax, of the OrderItemSummary. This is a calculated field.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 49.0

  • Description:

    Total price of the OrderItemSummary, inclusive of adjustments and tax. This amount is equal to AdjustedLineAmount + TotalAdjustedLineTaxAmount.

    This is a calculated field.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 60.0

  • Description:

    ID of the associated asset.

    This field is a relationship field.

  • Relationship name: Asset

  • Relationship type: relationship

  • Refers to: Asset

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 62.0

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 63.0

  • Relationship name: BillingTreatment

  • Relationship type: relationship

  • Refers to: BillingTreatment

  • Type: string

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    Description of the OrderItemSummary.

    This field can be edited.

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 61.0
  • Description: Earliest date when the item is estimated to be delivered.
  • Type: time
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 61.0
  • Description: Earliest time of the day when the item is estimated to be delivered.

  • Type: date

  • Properties: Create, Filter, Group, Nillable, Sort, Update

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

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 61.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 61.0

  • Type: currency

  • Properties: Create, Filter, Nillable, Sort, Update

  • Introduced: API version 49.0

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

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 61.0
  • Type: time
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 61.0

  • Type: int

  • Properties: Create, Filter, Group, Nillable, Sort, Update

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

  • Type: currency

  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update

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

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 62.0

  • Description:

    The primary order item summary ID of this order item summary.

    This field is a relationship field.

  • Relationship name: MainOrderItemSummary

  • Relationship type: relationship

  • Refers to: OrderItemSummary

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the OrderItemSummary.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 62.0

  • Relationship name: OrderAction

  • Relationship type: relationship

  • Refers to: OrderAction

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    ID of the OrderDeliveryGroupSummary to which this object belongs.

    This field is a relationship field.

  • Relationship name: OrderDeliveryGroupSummary

  • Relationship type: relationship

  • Refers to: OrderDeliveryGroupSummary

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    ID of the OrderSummary to which this object belongs.

    This field is a relationship field.

  • Relationship name: OrderSummary

  • Relationship type: masterdetail

  • Refers to: OrderSummary

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

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

    This field is a relationship field.

  • Relationship name: OriginalOrderItem

  • Relationship type: relationship

  • Refers to: OrderItem

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 62.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 62.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 62.0

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 54.0

  • Description:

    ID of the pricebook entry associated with this OrderItemSummary.

    This field is a relationship field.

  • Relationship name: PricebookEntry

  • Relationship type: relationship

  • Refers to: PricebookEntry

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 67.0

  • Relationship name: PricingContract

  • Relationship type: relationship

  • Refers to: Contract

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 62.0

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    ID of the product represented by this OrderItemSummary.

    This field is a relationship field.

  • Relationship name: Product2

  • Relationship type: relationship

  • Refers to: Product2

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Product code of the product represented by this OrderItemSummary.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 60.0

  • Relationship name: ProductSellingModel

  • Relationship type: relationship

  • Refers to: ProductSellingModel

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 62.0

  • Relationship name: ProrationPolicy

  • Relationship type: relationship

  • Refers to: ProrationPolicy

  • Type: double

  • Properties: Create, Filter, Sort, Update

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

  • Type: double

  • Properties: Create, Filter, Sort, Update

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

  • 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. This is a calculated field.
  • 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. This is a calculated field.
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 53.0
  • Description: Quantity available to be reshipped on this OrderItemSummary. Equal to QuantityFulfilled minus (QuantityReshipped and QuantityReturnInitiated). This is a calculated field.
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Quantity available to be returned on this OrderItemSummary. Equal to QuantityFulfilled minus QuantityReturnInitiated. This is a calculated field.

  • Type: double

  • Properties: Create, Filter, Sort, Update

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

  • Type: double

  • Properties: Create, Filter, Sort, Update

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

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: Quantity available to be allocated on this OrderItemSummary. Equal to QuantityOrdered minus QuantityCanceled.

  • Type: double

  • Properties: Create, Filter, Sort, Update

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

  • Type: double

  • Properties: Create, Filter, Nillable, Sort, Update

  • Introduced: API version 53.0

  • Description:

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

  • Type: double

  • Properties: Create, Filter, Sort, Update

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

  • Type: double

  • Properties: Create, Filter, Sort, Update

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

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Description: Quantity shipped on this OrderItemSummary.
  • Type: currency
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Description: The original or reference price of the order product.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Reserved for future use.
  • Relationship name: ReservedAtLocation
  • Relationship type: polymorphic
  • Refers to: Location, LocationGroup

  • Type: date

  • Properties: Create, Filter, Group, Nillable, Sort, Update

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

  • Type: picklist

  • Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

  • Description:

    Status of the OrderItemSummary. The default value is ORDERED. When a quantity value changes, each status formula is evaluated in order. If a formula is true, no more evaluations are performed for that change.

    Possible values and their formulas, in the order of evaluation, are:

  • Possible values:

    • RETURNINITIATED — RETURNINITIATED — Return Initiated — (Quantity > 0) & (QuantityReturnInitiated = QuantityFulfilled) & (QuantityReturned < QuantityReturnInitiated)
    • RESHIPPED — RESHIPPED — Reshipped — (QuantityReshipped = QuantityFullfilled) & (QuantityFullfilled > 0) & (QuantityReturnInitiated = 0) & (QuantityFulfilled = QuantityOrdered)
    • RETURNED — RETURNED — Returned — (Quantity = 0) & (QuantityReturned > 0)
    • CANCELED — CANCELED — Canceled — (Quantity = 0) & (QuantityCancelled > 0) & (QuantityReturned = 0)
    • FULFILLED — FULFILLED — Fulfilled — (Quantity > 0) & ((QuantityOrdered - QuantityCancelled) <= QuantityFulfilled)
    • PARTIALLYFULFILLED — PARTIALLYFULFILLED — Partially Fulfilled — (QuantityFulfilled > 0) & (QuantityFulfilled < (QuantityOrdered - QuantityCancelled))
    • ALLOCATED — ALLOCATED — Allocated — (Quantity > 0) & (Quantity <= QuantityAllocated)
    • PARTIALLYALLOCATED — PARTIALLYALLOCATED — Partially Allocated — (QuantityAllocated > 0) & (QuantityAllocated < Quantity)
    • ORDERED — ORDERED — Ordered — None of the other formulas apply
    • PAID — PAID — Paid — N/A
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 49.0
  • Description: The stock keeping unit (SKU) of the Product2 associated with the OrderItemSummary.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 63.0

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 63.0

  • Description:

    The ID of the related tax treatment. This field is available with Subscription Management.

    This field is a relationship field.

  • Relationship name: TaxTreatment

  • Relationship type: relationship

  • Refers to: TaxTreatment

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the AdjustedLineAmount. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total of all price adjustments applied to this OrderItemSummary. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total amount of all price adjustments applied to this OrderItemSummary, inclusive of tax. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount. This is a calculated field.
  • 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. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total amount of the order-level price adjustments applied to this OrderItemSummary, inclusive of tax. This amount is equal to TotalAdjustmentDistAmount + TotalAdjustmentDistTaxAmount. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalAdjustmentDistAmount. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalAdjustmentAmount. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total price of the OrderItemSummary, inclusive of tax. This amount is equal to TotalPrice + TotalTaxAmount. This is a calculated field.
  • Type: currency
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • 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. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total of all non-order-level price adjustments applied to this OrderItemSummary, inclusive of tax. This amount is equal to TotalLineAdjustmentAmount + TotalLineAdjustmentTaxAmount. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalLineAdjustmentAmount. This is a calculated field.

  • Type: currency

  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update

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

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total unadjusted amount of the OrderItemSummary, inclusive of tax. This amount is equal to TotalLineAmount + TotalLineTaxAmount. This is a calculated field.
  • Type: currency
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalLineAmount. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total, including line and order-level adjustments but not tax, of the OrderItemSummary. This is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalPrice. This is a calculated field.

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description:

    Type of the OrderItemSummary. Delivery Charge indicates that the OrderItemSummary represents a delivery charge. Fee indicates that it represents another type of fee, such as a return fee. 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.

    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.

  • Possible values:

    • Delivery Charge (Charge) — Delivery Charge (Charge)
    • Fee (Charge) — Fee (Charge)
    • Order Product (Product) — Order Product (Product)

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description:

    Type code of the OrderItemSummary. Charge indicates that the OrderItemSummary represents a charge or fee. Product indicates that it represents any other type of product, service, or charge. A type code can be associated with one or more types.

    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.

  • Possible values:

    • Charge — Charge
    • Product — Product

  • Type: currency

  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update

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

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 62.0

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.