OrderItem

Standard object representing a single line item (product or charge) on an Order. In Manufacturing/Automotive/Consumer Goods Cloud orgs with Advanced Orders enabled, OrderItem is extended with fields linking each line to an OrderItemSpec template and carrying additional pricing/quantity metadata used during order capture and pricing calculation. This object is available in API version 68.0 and later.

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

No additional setup or permissions beyond standard object- and field-level security are required to use the standard OrderItem object. The Manufacturing/Automotive/Consumer Goods-specific extension field OrderItemSpecId, along with related quantity/pricing fields (RecommendedQuantity, TargetQuantity, IsPreviouslyOrderedItem, IsPromotedProduct, FreeItemParentType, FreeItemPricingStep), requires the Advanced Orders feature to be enabled and populated.

Type: double

Properties: Filter, Nillable, Sort

Description: The quantity of the ordered product currently available to fulfill this line item. This is a calculated, read-only field.

Type: picklist

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

Description: The ISO code for the currency of this record. Possible values are: AED (UAE Dirham), USD (U.S. Dollar), and every other active currency ISO code configured for the org. The default value is USD.

Type: string

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

Description: A text description of the order line item.

Type: percent

Properties: Create, Filter, Nillable, Sort, Update

Description: The discount percentage applied to this line item.

Type: date

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

Description: The date this order line item’s terms end.

Type: picklist

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

Description: Specifies the type of parent record associated with the free item. Possible values are Item, Order, and Reward.

Type: string

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

Description: The calculation step or rule that generates the free item.

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether the product on this line item belongs to the account’s product authorization list. The default value is false.

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether the ordered product was out of stock at the time of order capture. The default value is false.

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether this product was previously ordered by the account. The default value is false.

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether this product was promoted (recommended or suggested) to the buyer during order capture. The default value is false.

Type: currency

Properties: Create, Filter, Nillable, Sort

Description: The list price of the product before any discounts or pricing adjustments.

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: A manually entered price that overrides the pricing engine’s calculated price.

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The net total price for this line item (unit price × quantity) after all pricing adjustments.

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The net unit price for this line item after all pricing adjustments.

Type: reference

Properties: Create, Filter, Group, Sort

Description: The parent Order this line item belongs to.

Relationship Name: Order

Refers To: Order

Type: string

Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort

Description: The auto-generated line item number.

Type: reference

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

Description: The OrderItemSpec (line-item specification template) that governs this line item’s behavior. Part of the Advanced Orders feature.

Relationship Name: OrderItemSpec

Refers To: OrderItemSpec

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The original OrderItem this line item references, for example on a change or return order.

Relationship Name: OriginalOrderItem

Refers To: OrderItem

Type: string

Properties: Filter, Group, Nillable, Sort

Description: The waterfall execution identifier generated by the pricing procedure for this line item.

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The PricebookEntry that determines the pricing for this line item.

Relationship Name: PricebookEntry

Refers To: PricebookEntry

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The Product2 ordered on this line item.

Relationship Name: Product2

Refers To: Product2

Type: picklist

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

Description: The reason the ordered quantity was modified from its original or recommended value.

Type: double

Properties: Create, Filter, Sort, Update

Description: The quantity of the product ordered on this line item.

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The UnitOfMeasure in which Quantity is expressed.

Relationship Name: QuantityUnitOfMeasure

Refers To: UnitOfMeasure

Type: picklist

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

Description: The reason for a mismatch between the ordered and received quantity.

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The quantity recommended for this line item, for example by a replenishment or AI recommendation engine.

Type: reference

Properties: Filter, Group, Nillable, Sort

Description: A related OrderItem, such as a corresponding line on a linked order.

Relationship Name: RelatedOrderItem

Refers To: OrderItem

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The quantity of this line item still remaining to be fulfilled.

Type: currency

Properties: Filter, Nillable, Sort

Description: The line amount for this item after rounding rules are applied. This is a calculated, read-only field.

Type: date

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

Description: The date the product or service on this line item is to be delivered or performed.

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The target quantity for this line item, used for goal-based or promotional order guidance.

Type: currency

Properties: Create, Filter, Sort, Update

Description: The total amount of pricing adjustments applied to this line item.

Type: currency

Properties: Filter, Nillable, Sort

Description: The total amount for this line item, including tax. This is a calculated, read-only field.

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The total amount for this line item, excluding tax.

Type: currency

Properties: Filter, Nillable, Sort

Description: The total price for this line item (unit price × quantity), before adjustments. This is a calculated, read-only field.

Type: currency

Properties: Create, Filter, Sort, Update

Description: The total tax amount for this line item.

Type: picklist

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

Description: The type of line item. Possible values are Delivery Charge, Fee, and Order Product.

Type: picklist

Properties: Filter, Group, Nillable, Restricted picklist, Sort

Description: The system type code of the line item. Possible values are Charge and Product.

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The unit price for this line item before pricing adjustments.

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.