Frontend | Backend | Api

Orders\Models\Backend\Order

Method Description Returns
hasModelMethod(string $methodName) bool
get(string $propertyName, array $parameters)
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
getHateoasLinks() Get the HATEOAS links for the record array
getEditUrl() Get the url for editing the record. string
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() Get item total Money
getDiscountTotalAsMoney() Get discount total as Money object Money
getSurchargeTotalAsMoney() Get surcharge total as Money object Money
getShippingTotalAsMoney() Get shipping total as Money object Money
getHandlingTotalAsMoney() Get handling total as Money object Money
getTaxTotalAsMoney() Get tax total as Money object Money
getInsuranceTotalAsMoney() Get insurance total as Money object Money
getTotalAsMoney() Get total as Money object 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
getDiscountCodes() array
getAppliedDiscounts() array
getTotal() string
getDiscountTotal() string
getSurchargeTotal() string
getShippingTotal() string
getHandlingTotal() string
getTaxTotal() string
getInsuranceTotal() 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)