OrderItem

Represents an order product that your organization sells.

Supported Calls

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

Special Access Rules

The user must have Edit permission on Order records to create or update order products on an order. The user must have Edit permission on Order records to delete an order product.

Fields

Field Name	Details
AdjustedLineAmount	Type currency Properties Filter, Nillable, Sort Description Line amount following line adjustments, excluding tax. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
AdjustedLineAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Line amount following line adjustments, including tax. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later.
AggregatedQuantity	Type double Properties Filter, Nillable, Sort Description The quantity of a order item's grouped transaction lines or the products that have been sold and converted to assets. This field is available in API version 64.0 and later.
AvailableQuantity	Type double Properties Filter, Nillable, Sort Description The amount of an order product that is available to be reduced. Value must be greater than or equal to 0. An order product is reducible only if AvailableQuantity is greater than 0. Value is always 0 if the order product’s parent order is a reduction order.
BatchIdentifier	Type string Properties Filter, Group, Nillable, Sort Description Identifies a product bundle in a transaction processing batch to ensure that order items from the same bundles are processed together. This field is available in API version 64.0 and later.
BillingFrequency2	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time period that indicates how often the order item is billed. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: `Annual` `Monthly`
CurrencyIsoCode	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the original Order associated with the OrderItem. Possible values are: `DKK`—Danish Krone `EUR`—Euro `GBP`—British Pound `USD`—U.S. Dollar The default value is `USD`. This field is available in API version 49.0 and later.
DeliveryEstimationReference	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique reference ID for the delivery estimation.
DeliveryEstimationTimeZone	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Time zone in which the estimated delivery times are based.
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Text description of this object. For Commerce stores, during checkout, this field is populated with the value of a product name. The product name is copied from the CartItem.Name field of a cart item that corresponds to the OrderItem.
DoesAutomaticallyRenew	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the order item is set to automatically renew (true) or not (false). This field is available in API version 64.0 and later.
EarliestEstimatedDeliveryDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Earliest estimated date for the item to be delivered.
EarliestEstimatedDeliveryTime	Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description Earliest estimated time of the day for the item to be delivered.
EndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. Last day the order product is available.
EndDateTime	Type datetime Properties Create, Filter, Group, Nillable, Sort, Update Description The end date and time of the order item, derived from the End Date and End Time fields in the time zone specified in the Start and End Time Zone field. If the time zone isn't specified, the default is Coordinated Universal Time (UTC). Label is End Date Time. This field is available in Revenue Cloud in API version 65.0 and later.
EndTime	Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description The end time of the order item. Label is End Time. This field is available in Revenue Cloud in API version 65.0 and later.
GrossUnitPrice	Type currency Properties Create, Filter, Nillable, Sort, Update Description Unit price including tax. This field is a VAT field that includes tax. Salesforce populates it on order creation only when Order.TaxLocaleType has a value of Gross.
IsOrderItemLocked	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the order item and its children are locked (true) or not (false). Locked order items and their children cannot be modified, added, or deleted. This field is available in API version 63.0 and later.
LastEstimatedDeliveryDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Latest estimated date for the item to be delivered.
LastEstimatedDeliveryTime	Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description Latest estimated time of the day for the item to be delivered.
LineNumber	Type int Properties Create, Filter, Group, Nillable, Sort Description The number used to organize lines on the order. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
ListPrice	Type currency Properties Create, Filter, Nillable, Sort Description List price for the order product. Inherited value from the associated PriceBookEntry upon order product creation.
ListPriceTotal	Type currency Properties Create, Filter, Nillable, Sort, Update Description The ListPrice times the Quantity. This field is a calculated field. This field is available in API version 55.0 and later. This field is available with Subscription Management.
NetUnitPrice	Type currency Properties Create, Filter, Nillable, Sort, Update Description The unit price after all price adjustments are applied. This field is available in API version 55.0 and later. This field is available with Subscription Management.
OrderActionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related order action. The order action indicates the type of order; for example, a new sale or a cancellation. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name OrderAction Relationship Type Lookup Refers To OrderAction
OrderDeliveryGroupId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The delivery group for the order product. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later. This field is a relationship field. Relationship Name OrderDeliveryGroup Relationship Type Lookup Refers To OrderDeliveryGroup
OrderId	Type reference Properties Create, Filter, Group, Sort Description Required. ID of the order that this order product is a child of. This field is a relationship field. Relationship Name Order Relationship Type Lookup Refers To Order
OrderItemNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Automatically generated number that identifies the order product.
OriginalOrderItemId	Type reference Properties Create, Filter, Group, Nillable, Sort Description Required if isReductionOrder on the parent order is `true`. ID of the original order product being reduced. This field is a relationship field. Relationship Name OriginalOrderItem Relationship Type Lookup Refers To OrderItem
PeriodBoundary	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The period boundary helps determine the start and end date of the billing periods. This field is available in API version 55.0 and later. This field is available with Subscription Management and Revenue Cloud. Possible values are: `AlignToCalendar`—the period starts on the first day of the term unit; for example, the first day of the month. `Anniversary`—The start date determines the boundary. For example, if a monthly subscription starts on September 13, the subscription starts on the 13th day of each month. `DayOfPeriod`—the period starts on the day indicated by PeriodBoundaryDay. `LastDayOfPeriod`—the period starts on the last day of the pricing term unit; for example, the last day of the month. Keep these considerations in mind for amendment, renewal, and cancellations of assets in Revenue Cloud. The value of the PeriodBoundary field is copied from the AssetActionSource (initial sale), by default. For termed selling models where the PeriodBoundary value is `Anniversary`, the value of the PeriodBoundary field is automatically converted to `DayOfPeriod`. Start date adjustment operation on an asset preserves the original value without conversion.
PeriodBoundaryDay	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Required when PeriodBoundary is `DayOfPeriod`. Indicates the day of the week or month that marks the period boundary. Must be an integer from 1 through 31. This field is available in API version 55.0 and later. This field is available with Subscription Management and Revenue Cloud. Keep these considerations in mind for amendment, renewal, and cancellations of assets in Revenue Cloud. The value of the PeriodBoundary field is copied from the AssetActionSource (initial sale), by default. When PeriodBoundary field value is converted from `Anniversary` to `DayOfPeriod` for termed selling models, the value of the PeriodBoundaryDay field is automatically populated with the day value from AssetActionSource.StartDate. Start date adjustment operation on an asset preserves the original value without conversion.
PeriodBoundaryStartMonth	Type picklist Properties Create, Filter, Group, Restricted picklist, Nillable, Sort, Update Description The field is populated based on input in the StartDate, PeriodBoundary, and PeriodBoundaryDay when BillingFrequency2 is Annual or by manual user entry. Possible values are: `1-January` `2-February` `3-March` `4-April` `5-May` `6-June` `7-July` `8-August` `9-September` `10-October` `11-November` `12-December` Keep these considerations in mind for amendment, renewal, and cancellations of assets in Revenue Cloud. The value of the PeriodBoundary field is copied from the AssetActionSource (initial sale), by default. For termed selling models where PeriodBoundary field value is `Anniversary` and PricingTermUnit field value is `ANNUAL`, `SEMI_ANNUAL`, or `QUARTERLY`, the value of the PeriodBoundaryStartMonth field is automatically recalculated by using AssetActionSource.StartDate.month. Start date adjustment operation on an asset preserves the original value without conversion.
PricebookEntryId	Type reference Properties Create, Filter, Group, Nillable, Sort Description Required. ID of the associated PricebookEntry. Specify this field when creating OrderItem records. It can’t be changed in an update. If you have a B2B Commerce, B2B Commerce Starter, B2B Commerce Growth, or B2B Commerce Plus license, Salesforce users can create orders without price books and order items without price book entries. This field is a relationship field. Relationship Name PricebookEntry Relationship Type Lookup Refers To PricebookEntry
PriceRevisionPolicyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The price uplift policy associated with this order item. This field is a relationship field. Relationship Name PriceRevisionPolicy Refers To PriceRevisionPolicy Label is Price Revision Policy. This field is available in Revenue Cloud in API version 65.0 and later.
PricingTermCount	Type double Properties Create, Filter, Nillable, Sort, Update Description A calculated field indicating the number of pricing terms in the subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management.
PricingTransactionType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the type of pricing transaction. For example, a new sale, a cancellation, an amendment, or a renewal. Possible values: `AmendmentAtLastNegotiatedPrice`—Calculate the price of the amended order item by using the same price book and price adjustments as the new sale item. For example, an order item that is amended by using a pricing transaction type of AmendmentAtLastNegotiatedPrice is priced by using the same price book information and price adjustments as the new sale item. The amended order item has the same price as the new sale order item. `AmendmentStartingFromListPrice`—Calculate the price of the amended order item by using current price book information, disregarding any pricing information or adjustments that were applied to the new sale item. Typically, an amended order item has a different price than the new sale transaction item. `Cancellation`—Calculate the price of the canceled transaction. For example, a 1-year subscription purchased on January 1, is canceled on July 31. The price of the canceled products and services from August 1 through Dec 31 is calculated. `NewSale`—The price of a new transaction is calculated. `RenewalAtLastNegotiatedPrice`—Calculate the price of the order item by using the same price book and price adjustments as the new sale item. For example, an order item that is renewed by using a pricing transaction type of `RenewalAtLastNegotiatedPrice` is priced by using the same price book information and price adjustments as the new sale item. The renewal order item has the same price as the new sale order item. `RenewalAtListPrice`—Calculate the price of the order item by using current price book information, disregarding any pricing information or adjustments that were applied to the new sale item. Typically, a renewal order item has a different price than the new sale order item. This field is available in API version 55.0 and later. This field is available with Subscription Management.
ProFormaBillingPeriodAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The initial amount for the billing period. The final amount for the billing period can include subsequent amendments, discounts, or charges. This field is available in API version 55.0 and later. This field is available with Subscription Management.
Product2Id	Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Product2 associated with this OrderItem. This field is a relationship field. Relationship Name Product2 Relationship Type Lookup Refers To Product2
ProductSellingModelId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related product selling model. The product selling model defines one method by which a product is sold; for example, as a one-time sale, an evergreen subscription, or a termed subscription. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name ProductSellingModel Relationship Type Lookup Refers To ProductSellingModel
ProrationPolicyId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the related proration policy. The proration policy defines how the price is calculated for each subscription period. For example, whether partial periods are allowed, and how the remainder amounts are handled. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name ProrationPolicy Relationship Type Lookup Refers To ProrationPolicy
Quantity	Type double Properties Create, Filter, Sort, Update Description Required. Number of units of this order product.
QuoteLineItemId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. ID of the associated quote line item. If this field is specified, the quote line item’s QuoteId must match the QuoteId for the order product’s parent order.
ReferencePrice	Type currency Properties Create, Filter, Nillable, Sort Description The original or reference price of the order product. This field is available in API version 63.0 and later.
RelatedChangeIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort Description The identifier used to group all related order items in the same change order. This field is available in API version 63.0 and later.
RelatedOrderItemID	Type reference Properties Create, Filter, Sort, Group Description Required for change orders, shows the original order product. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
RoundedLineAmount	Type currency Properties Filter, Sort Description The rounded line amount, before tax and adjustments. Currency with decimal values of 0.5 and higher round to the next-highest whole unit of currency. The formula to calculate the rounded line amount is: IF(TotalLineAmount != NULL, TotalLineAmount, Quantity * UnitPrice) This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
RoundedLineAmtWithTax	Type currency Properties Filter, Nillable, Sort Description The rounded line amount, including tax. Currency with decimal values of 0.5 and higher round to the next-highest whole unit of currency. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later.
SegmentType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The duration type of the segment. You can use this field from Revenue Cloud only when the Ramp Deals for Groups in Quotes and Orders setting is turned on. Valid values are: `Custom`—Available in API version 65.0 and later. `Prorated`—Available in API version 67.0 and later. `Trial`—Available in API version 67.0 and later. `Yearly`—Available in API version 65.0 and later. The default value is `Yearly`.
ServiceDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Start date for the order product. Label is Start Date.
ServiceDateTime	Type datetime Properties Create, Filter, Group, Nillable, Sort, Update Description The service date and time of the order item, which is derived from the Service Date and Service Time fields in the time zone specified in the Service and End Time Zone field. If the time zone isn't specified, the default is Coordinated Universal Time (UTC). Label is Service Time. This field is available in Revenue Cloud in API version 65.0 and later.
ServiceEndTimeZone	Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the time zone for the order item's service and end dates, times, and datetimes. Label is Service and End Time Zone. This field is available in Revenue Cloud in API version 65.0 and later.
ServiceTime	Type timeOnly Properties Create, Filter, Group, Nillable, Sort, Update Description The service time of the order item. Label is Service Time. This field is available in Revenue Cloud in API version 65.0 and later.
StartingPriceTotal	Type currency Properties Create, Filter, Nillable, Sort, Update Description The starting unit price times the quantity. This field is available in API version 55.0 and later. This field is available with Subscription Management.
StartingUnitPriceSource	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the starting unit price was entered manually or calculated. This field is available in API version 55.0 and later. This field is available with Subscription Management. Possible values are: `Manual` `System`
SupplementalChangeType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the order item change type in the supplemental order. Possible values are: `Add` `Amend` `Cancel` `No Change` This field is available in API version 64.0 and later.
TaxTreatmentId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related tax treatment. This field is available in API version 55.0 and later. This field is available with Subscription Management. This field is a relationship field. Relationship Name TaxTreatment Relationship Type Lookup Refers To TaxTreatment
TotalAdjustedLineTaxAmount	Type currency Properties Filter, Sort Description Sum of line tax amount and line adjustment tax amounts. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalAdjustmentAmount	Type currency Properties Filter, Sort Description Roll up of the order product’s price adjustments. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalAdjustmentAmtWithTax	Type currency Properties Filter, Sort Description Roll up of the order product’s price adjustments, including tax. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later.
TotalAdjustmentDistAmount	Type currency Properties Filter, Sort Description Roll up of all adjustments on the order. Used only if the OrderAdjustmentGroup has a Type value of Header. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalAdjustmentDistTaxAmount	Type currency Properties Filter, Sort Description Roll up of all adjustment tax amounts on the order. Used only if the OrderAdjustmentGroup has a Type value of Header. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalAdjustmentDistAmtWithTax	Type currency Properties Filter, Sort Description Roll up of all adjustment tax amounts on the order, including tax. Used only if the OrderAdjustmentGroup has a Type value of Header. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later.
TotalAdjustmentTaxAmount	Type currency Properties Filter, Sort Description Sum of the order product’s tax adjustments. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Equals TotalPrice + TotalTaxAmount for the order item. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later.
TotalLineAdjustmentAmount	Type currency Properties Filter, Sort Description The sum of line-level adjustments for the order product. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalLineAdjustmentAmtWithTax	Type currency Properties Filter, Sort Description The sum of line-level adjustments for the order product, including tax. This field is a gross tax field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v49.0 and later.
TotalLineAdjustmentTaxAmount	Type currency Properties Filter, Sort Description Total tax amount for adjustments made to the order product. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalLineAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The line amount of the order product, before price adjustments, inclusive of quantity, and pricing term count for subscription. The decimal places for this value must match the decimal places for the currency being used. For example, if the currency is the US dollar, the decimal place for TotalLineAmount must be 2. If the currency is the Japanese yen, the decimal place for TotalLineAmount must be 0. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalLineTaxAmount	Type currency Properties Filter, Sort Description Total tax amount for this order product, excluding tax on adjustments. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalPrice	Type currency Properties Filter, Nillable, Sort Description Total price for this order product. The calculations for this field’s value are different if Commerce Orders are enabled. Default Value TotalPrice = (UnitPrice * Quantity) Commerce or Revenue Cloud Orders If TotalLineAmount is null, then TotalPrice = (ROUND(UnitPrice * Quantity) + TotalAdjustmentAmount. The ROUND(UnitPrice * Quantity) is stored in the RoundedLineAmount field. Otherwise, TotalPrice = ROUND(TotalLineAmount) + TotalAdjustmentAmount. The ROUND(TotalLineAmount)is also stored in the RoundedLineAmount field. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TotalTaxAmount	Type currency Properties Filter, Sort Description Sum of the order product’s tax and any adjustments. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
Type	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Describes what the order item represents. Each value is associated with one type code, shown here in parentheses. Possible values are: `Delivery Charge (Charge)` — A charge, such as a delivery fee. `Fee (Charge)` — A charge, such as a return fee. This value is available in API v56.0 and later. `Order Product (Product)` — An item that can be ordered. This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
TypeCode	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The category associated with the type. A type code can be associated with one or more types. Possible values are: `Charge` `Product` This field is available with Salesforce Order Management or Revenue Cloud. This field is available in API v48.0 and later.
UnitPrice	Type currency Properties Create, Filter, Nillable, Sort, Update Description Unit price for the order product.
UnitPriceUplift	Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage increase of the order item's unit price.

Usage

An order can have associated order product records only if the order has a price book associated with it. An order product must correspond to a product that is listed in the order’s price book.

Orders with associated OrderItem records are affected. When OrderItem records are directly deleted, they aren’t sent to the recycle bin and can’t be undeleted. The getDeleted() call shows deleted OrderItem records until they’re purged, which is usually within the same day or the next day.

Associated Objects

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 and later.

OrderItemChangeEvent (API version 44.0): Change events are available for the object.
OrderItemFeed (API version 29.0): Feed tracking is available for the object.
OrderItemHistory: History is available for tracked fields of the object.

Object Reference for the Salesforce Platform