Description
An OrderItem represents a single item in an Order.
ℹ️ Note
This object supports custom data via the data attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
bookable_event |
BookableEvent | Returns the BookableEvent for this item's Product if any |
bookable? |
Boolean | Returns true if the OrderItem is for a bookable Product |
bundle_items |
List[OrderItem] | Returns the OrderItems contained in the Bundle |
bundle_lead? |
Boolean | Returns true if the item's Product is the lead item in a bundle |
custom_forms |
List[CustomForm] | Returns the CustomForms for this OrderItem |
id |
String | Returns the unique id for this OrderItem |
in_bundle? |
Boolean | Returns true if the OrderItem is in a bundle |
name |
String | Returns the name of the OrderItem Product |
order |
Order | Returns the Order that this OrderItem belongs to |
pricebook_entry |
PricebookEntry | Returns the PricebookEntry for this OrderItem |
pricing |
ProductPricing | Returns the Pricing for this OrderItem |
product |
Product | Returns the Product for this OrderItem |
quantity |
Number | Returns the value of the Quantity attribute |
reserved_product? |
Boolean | Returns true if the OrderItem represents a reserved Product |
subscription |
Subscription | Returns the Subscription for this OrderItem |
subscription_term_count |
Number | Returns the number of terms for the Subscription |
unit_price_excl_tax |
Number | Returns the unit price without exclusive tax |
unit_price_incl_tax |
Number | Returns the unit price with exclusive tax |
Deliveries
Attributes related to delivery windows
| Attribute | Type | Description |
|---|---|---|
delivery_date |
Timestamp | Returns the selected delivery date for this OrderItem |
delivery_day |
String | Returns the selected delivery day for this OrderItem |
delivery_time |
String | Returns the selected delivery timeslot for this OrderItem |
delivery_window |
DeliveryWindow | Returns the selected DeliveryWindow for this OrderItem |