| getFulfillmentStatusLabels() |
Gets all available fulfillment statuses with their labels |
array
|
| getFulfillmentStatusDisplay() |
Gets fulfillment status display label |
string
|
| getFinancialStatusLabels() |
Gets all available financial statuses with their labels |
array
|
| getFinancialStatusDisplay() |
Gets financial status display label |
string
|
| getRefundedTotalAsMoney() |
Get the amount refunded |
Money
|
| isRefundable() |
Is the order refundable? |
bool
|
| getNumber() |
|
string
|
| getOrdered() |
The time which order was placed |
DateTime
|
| getFinancialStatus() |
Set the financial status of the order. Values include : unpaid, authorized, partially_paid, paid, partially_refunded, refunded, voided. |
string
|
| getFulfillmentStatus() |
Set the fulfillment status of the order. Values include : none, pending, partial, fulfilled, completed. |
string
|
| getRefunds() |
|
Collection (Refund)
|
| 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
|
| getData() |
|
array
|
| 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
|
| getPerson() |
|
Person
|
| 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)
|