Commerce Commerce 1.x Class Reference Model comSessionCartOrderItem
Representation of an item in a cart order that’s only stored in the user session.
Meta
- Extends:
comOrderItem - Table:
modx_commerce_order_item
Relations
-
Order: onecomOrderobject (comSessionCartOrderItem.order = comOrder.id) -
Product: onecomProductobject (comSessionCartOrderItem.product = comProduct.id) -
TaxGroup: onecomTaxGroupobject (comSessionCartOrderItem.tax_group = comTaxGroup.id) -
DeliveryType: onecomDeliveryTypeobject (comSessionCartOrderItem.delivery_type = comDeliveryType.id) -
Shipment: onecomOrderShipmentobject (comSessionCartOrderItem.shipment = comOrderShipment.id)
Fields
| Field | Type | Description |
|---|---|---|
| id | integer (INTEGER) |
Primary key |
| class_key | string (varchar[100]) |
Type of object |
| properties | array (text)may be null |
Serialized arbitrary data stored with an object. Use utility methods instead of directly accessing these values: getProperty($key, $default), getProperties(), setProperty($key, $value), setProperties($properties, $merge), unsetProperty($key), unsetProperties($keys) |
| order | integer (int[10]) |
|
| product | integer (int[10]) |
|
| idx | integer (int[20]) |
|
| currency | string (varchar[3]) |
|
| status | integer (int[10]) |
|
| allow_update Default: 1 |
boolean (tinyint[1]) |
|
| is_manual_price | boolean (tinyint[1]) |
|
| tax_group | integer (int[20]) |
|
| delivery_type | integer (int[20]) |
|
| shipment | integer (int[10]) |
|
| sku Default: (missing sku) |
string (varchar[190]) |
|
| name Default: (missing name) |
string (varchar[1024]) |
|
| name_primary Default: (missing name) |
string (varchar[1024]) |
|
| link | string (varchar[1024])may be null |
|
| description | string (varchar[1024]) |
|
| description_primary | string (varchar[1024]) |
|
| price | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| price_formatted | price passed through the financial formatter |
|
| regular_price | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| regular_price_formatted | regular_price passed through the financial formatter |
|
| image | string (varchar[190])may be null |
|
| quantity Default: 1 |
integer (int[20]) |
|
| subtotal_before_extra | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| subtotal_before_extra_formatted | subtotal_before_extra passed through the financial formatter |
|
| extra | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| extra_formatted | extra passed through the financial formatter |
|
| subtotal | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| subtotal_formatted | subtotal passed through the financial formatter |
|
| discount | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| discount_formatted | discount passed through the financial formatter |
|
| shipping | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| shipping_formatted | shipping passed through the financial formatter |
|
| total_before_tax | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| total_before_tax_formatted | total_before_tax passed through the financial formatter |
|
| total_ex_tax | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| total_ex_tax_formatted | total_ex_tax passed through the financial formatter |
|
| tax | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| tax_formatted | tax passed through the financial formatter |
|
| total | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| total_formatted | total passed through the financial formatter |
|
| comment | string (varchar[1024]) |