Commerce Commerce 1.x Class Reference Model comSessionCartOrder
Representation of a cart order that’s only stored in the user session.
Meta
- Extends:
comCartOrder - Table:
modx_commerce_order
Relations
Context: onemodContextobject (comSessionCartOrder.context = modContext.key)Status: onecomStatusobject (comSessionCartOrder.status = comStatus.id)CreatedBy: onemodUserobject (comSessionCartOrder.created_by = modUser.id)LastUpdatedBy: onemodUserobject (comSessionCartOrder.last_updated_by = modUser.id)StatusUpdatedBy: onemodUserobject (comSessionCartOrder.status_updated_by = modUser.id)ShippingMethod: onecomShippingMethodobject (comSessionCartOrder.shipping_method = comShippingMethod.id)Parent: onecomOrderobject (comSessionCartOrder.parent = comOrder.id)User: onemodUserobject (comSessionCartOrder.user = modUser.id)Descendants: manycomOrderobjects (comSessionCartOrder.id = comOrder.parent)Items: manycomOrderItemobjects (comSessionCartOrder.id = comOrderItem.order)Addresses: manycomOrderAddressobjects (comSessionCartOrder.id = comOrderAddress.order)Transactions: manycomTransactionobjects (comSessionCartOrder.id = comTransaction.order)Logs: manycomOrderLogobjects (comSessionCartOrder.id = comOrderLog.order)
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) |
| secret | string (varchar[191]) |
|
| test | boolean (tinyint[1]) |
|
| status | integer (int[10]) |
|
| payment_status | string (varchar[30]) |
One of: unpaid, authorized, partially_paid, paid, pending_refund, partially_refunded, refunded |
| origin Default: checkout |
string (varchar[40]) |
One of: manual, checkout, subscription |
| currency | string (varchar[3]) |
|
| context Default: web |
string (varchar[190])may be null |
|
| reference | string (varchar[190])may be null |
|
| reference_incr | integer (int[10])may be null |
|
| 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 |
|
| transaction | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| transaction_formatted | transaction 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 |
|
| total_authorized | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| total_authorized_formatted | total_authorized passed through the financial formatter |
|
| total_paid | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| total_paid_formatted | total_paid passed through the financial formatter |
|
| total_refunded | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| total_refunded_formatted | total_refunded passed through the financial formatter |
|
| total_due | integer (int[20]) |
Integer number in the currency base unit (e.g. cents) |
| total_due_formatted | total_due passed through the financial formatter |
|
| total_quantity | integer (int[20]) |
|
| created_on | int (int[20]) |
UNIX timestamp |
| created_on_formatted | created_on passed through the datetime formatter |
|
| received_on | int (int[20]) |
UNIX timestamp |
| received_on_formatted | received_on passed through the datetime formatter |
|
| last_updated_on | int (int[20]) |
UNIX timestamp |
| last_updated_on_formatted | last_updated_on passed through the datetime formatter |
|
| status_updated_on | int (int[20]) |
UNIX timestamp |
| status_updated_on_formatted | status_updated_on passed through the datetime formatter |
|
| created_by | int (int[10]) |
|
| last_updated_by | int (int[10]) |
|
| status_updated_by | int (int[10]) |
|
| shipping_method | integer (int[10]) |
|
| parent | int (int[10])may be null |
|
| user | int (int[10])may be null |