OrderItem

Represents an order product that your organization sells.

Supported Calls

create(), delete(), getDeleted(), getUpdated(), query(), retrieve(), update()

Fields

Field Name Details
AvailableQuantity
Type
double
Properties
Filter, Nillable, Sort
Description
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.

Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Text description of this object.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Optional. Last day the order product is available.
ListPrice
Type
currency
Properties
Filter, Nillable, Sort
Description
List price for the order product. Value is inherited from the associated PriceBookEntry upon order product creation.
OrderId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the order that this order product is a child of.
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.
PricebookEntryId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. ID of the associated PricebookEntry. This field must be specified when creating OrderItem records. It can’t be changed in an update.
Product2Id
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the Product2 associated with this OrderItem.
Quantity
Type
double
Properties
Create, Filter, Sort, Update
Description
Number of units of this order product.
QuoteLineItemId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
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.

ServiceDate
Type
date
Properties
Create, Filter, Nillable, Sort, Update
Description
Start date for the order product.
Label is Start Date.
UnitPrice
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Unit price for the order product.

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.

See Also