| AdjustedLineAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Line amount following line adjustments, excluding
tax.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| 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.
|
| LineNumber |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- Used to organize lines on the order.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| 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.
|
| OrderDeliveryGroupId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The delivery group for the order product.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| 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.
|
| RelatedOrderItemID |
- Type
- reference
- Properties
- Filter, Sort, Group
- Description
- For change orders, shows the original order
product.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- 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 are
rounded to the next-highest whole unit of currency.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| ServiceDate |
- Type
- date
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Start date for the order product.
- Label is Start Date.
|
| TotalAdjustedLineTaxAmount |
- Type
- currency
- Properties
- Filter, Sort
- Description
- Sum of line tax amount and line adjustment tax
amounts.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| TotalAdjustmentAmount |
- Type
- currency
- Properties
- Filter, Sort
- Description
- Roll-up of all the order product’s price
adjustments.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.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.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- 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.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| TotalAdjustmentTaxAmount |
- Type
- currency
- Properties
- Filter, Sort
- Description
- Sum of all the order product’s tax adjustments.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| TotalLineAdjustmentAmount |
- Type
- currency
- Properties
- Filter, Sort
- Description
- The sum of line-level adjustments for the order
product.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| TotalLineAdjustmentTaxAmount |
- Type
- currency
- Properties
- Filter, Sort
- Description
- Total tax amount for adjustments made to the order
product.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| TotalLineAmount |
- Type
- currency
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The total price of the order product, before price
adjustments, inclusive of quantity.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- 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.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| TotalPrice |
- Type
- currency
- Properties
- Filter, Sort
- Description
- Total price for this order product. The calculations for
this field’s value are different if Commerce Orders is
enabled.
- Default Value
-
TotalPrice =
(UnitPrice *
Quantity)
- Commerce Orders
- If TotalLineAmount is null,
(UnitPrice *
Quantity) is sent to
RoundedLineAmount and rounded.
It is then sent to Total Price.
Otherwise, TotalLineAmount is sent
to RoundedLineAmount, rounded, and
then sent to TotalPrice.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- 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.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- 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.
- Possible values are:
-
Delivery
Charge — An extra charge made
against an order.
-
Order Product
— An item that the customer has
bought.
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- This field is available in API v48.0 and later.
|
| TypeCode |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Code for the order product.
- Possible values are:
- To access Commerce Orders fields, your org must have a
Salesforce Order Management license. Commerce Orders
fields are available only in Lightning Experience.
- 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.
|