| getPerson() |
Gets the person linked to the ecommerce container. A {@link RestrictedPerson} is returned if the user is not an admin and the person isn't the logged-in user. |
Model | RestrictedPerson | null
|
| isPersonRestricted() |
Indicates whether the person linked to this container is being returned as a {@link RestrictedPerson} for the current request. |
bool
|
| isReadyForPayment() |
Checks if the checkout is ready for payment. There is a billing address set, there is a person and their email. Each fulfillment with a selected unexpired shipping rate. |
bool
|
| isFullyPaid() |
Has the checkout been fully paid? This checks if there are payment/s, or at least pre-authorizations, covering the checkout total. |
bool
|
| getSettledAmountAsMoney() |
Get the total amount which has been settled (authorized or captured) |
Money
|
| getSourceRecord() |
Get the source record |
Model
|
| getItemTotalAsMoney() |
Gets the item total as a Money object. Represents the sum of all items' Amount values. |
Money
|
| getShippingTotalAsMoney() |
Gets the shipping total as a Money object. Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. |
Money
|
| getHandlingTotalAsMoney() |
Gets the handling total as a Money object. Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. |
Money
|
| getInsuranceTotalAsMoney() |
Gets the insurance total as a Money object. Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. |
Money
|
| getDiscountTotalAsMoney() |
Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc. |
Money
|
| getTaxTotalAsMoney() |
Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc. |
Money
|
| getSurchargeTotalAsMoney() |
Gets the surcharge total as a Money object. Represents the surcharge total. |
Money
|
| getTotalAsMoney() |
Gets the grand total as a Money object. Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total`. |
Money
|
| getInvoices() |
Get all invoices linked to this order (Order, Checkout) |
Collection
|
| getCurrencyCode() |
Get currency code |
string
|
| getId() |
|
int
|
| getUuid() |
|
string
|
| getExternalId() |
|
string
|
| getComments() |
|
string
|
| getAppliedDiscounts() |
Metadata of the applied discounts. |
array
|
| getDiscountCodes() |
List of the applied discount codes. |
array
|
| getShippingTotal() |
Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. |
string
|
| getHandlingTotal() |
Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. |
string
|
| getInsuranceTotal() |
Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. |
string
|
| getDiscountTotal() |
Represents the sum of discount values across all line items, including shipping, handling, etc. |
string
|
| getTaxTotal() |
Represents the sum of tax values across all line items, including shipping, handling, etc. |
string
|
| getSurchargeTotal() |
Represents the surcharge total. |
string
|
| getTotal() |
Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total`. |
string
|
| getCreated() |
Date the record was created. |
DateTime
|
| getModified() |
Last modification date for the record. |
DateTime
|
| getBillingAddress() |
|
Address
|
| getDeliveryAddress() |
|
Address
|
| getCurrency() |
|
Currency
|
| getSite() |
|
Site
|
| getItems() |
|
Collection (Item)
|
| getFulfillments() |
|
Collection (Fulfillment)
|
| getMetadataFieldValues() |
|
Collection (MetadataFieldValue)
|
| getSourceEntity() |
Get the source record entity |
string
|
| getSourceUuid() |
Get the source record uuid |
string
|
| getDiscountLogs() |
|
Collection (Log)
|