ModelOrders module

Order

A model in the Orders module, with 48 members for templates, 50 API properties and 55 members for admin templates.

Orders\Models\Frontend\Order Orders\Models\Api\Order Orders\Models\Backend\Order Also in Orders: MetadataField MetadataFieldValue Refund RefundItem

Templates view

Properties 48

Take no arguments.

# getFulfillmentStatusLabels(): array; Gets all available fulfillment statuses with their labels
# getFulfillmentStatusDisplay(): string; Gets fulfillment status display label
# getFinancialStatusLabels(): array; Gets all available financial statuses with their labels
# getFinancialStatusDisplay(): string; Gets financial status display label
# getRefundedTotalAsMoney(): Money; Get the amount refunded
# isRefundable(): bool; Is the order refundable?
# getNumber(): ?string
# getOrdered(): ?DateTime; The time which order was placed
# getFinancialStatus(): ?string; Set the financial status of the order. Values include: unpaid, authorized, partially_paid, paid, partially_refunded, refunded, voided.
# getFulfillmentStatus(): ?string; Set the fulfillment status of the order. Values include: none, pending, partial, fulfilled, completed.
# getRefunds(): ?Collection<Refund>
# getItemTotalAsMoney(): Money; Gets the item total as a Money object. Represents the sum of all items' Amount values.
# getShippingTotalAsMoney(): Money; 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.
# getHandlingTotalAsMoney(): Money; 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.
# getInsuranceTotalAsMoney(): Money; 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.
# getDiscountTotalAsMoney(): Money; Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotalAsMoney(): Money; Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotalAsMoney(): Money; Gets the surcharge total as a Money object. Represents the surcharge total.
# getTotalAsMoney(): Money; 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.
# getInvoices(): Collection; Get all invoices linked to this order (Order, Checkout)
# getCurrencyCode(): string; Get currency code
# getId(): ?int
# getUuid(): ?string
# getExternalId(): ?string
# getComments(): ?string
# getData(): ?array
# getAppliedDiscounts(): array; Metadata of the applied discounts.
# getDiscountCodes(): array; List of the applied discount codes.
# getShippingTotal(): ?string; Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# getHandlingTotal(): ?string; Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# getInsuranceTotal(): ?string; Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# getDiscountTotal(): ?string; Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotal(): ?string; Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotal(): ?string; Represents the surcharge total.
# getTotal(): ?string; Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total.
# getCreated(): ?DateTime; Date the record was created.
# getModified(): ?DateTime; Last modification date for the record.
# getBillingAddress(): ?Address
# getDeliveryAddress(): ?Address
# getCurrency(): ?Currency
# getPerson(): ?Person
# getSite(): ?Site
# getItems(): ?Collection<Item>
# getFulfillments(): ?Collection<Fulfillment>
# getMetadataFieldValues(): ?Collection<MetadataFieldValue>
# getSourceEntity(): ?string; Get the source record entity
# getSourceUuid(): ?string; Get the source record uuid
# getDiscountLogs(): ?Collection<Log>

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 50

Read-only values on the record.

# fulfillmentStatusLabels: array; Gets all available fulfillment statuses with their labels
# fulfillmentStatusDisplay: string; Gets fulfillment status display label
# financialStatusLabels: array; Gets all available financial statuses with their labels
# financialStatusDisplay: string; Gets financial status display label
# refundedTotalAsMoney: Money; Get the amount refunded
# refundable: bool; Is the order refundable?
# hateoasLinks Not in Templates: array; Get the HATEOAS links for the record
# editUrl Not in Templates: ?string; Get the url for editing the record.
# number: ?string
# ordered: ?DateTime; The time which order was placed
# financialStatus: ?string; Set the financial status of the order. Values include: unpaid, authorized, partially_paid, paid, partially_refunded, refunded, voided.
# fulfillmentStatus: ?string; Set the fulfillment status of the order. Values include: none, pending, partial, fulfilled, completed.
# refunds: ?Collection<Refund>
# itemTotalAsMoney: Money; Gets the item total as a Money object. Represents the sum of all items' Amount values.
# shippingTotalAsMoney: Money; 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.
# handlingTotalAsMoney: Money; 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.
# insuranceTotalAsMoney: Money; 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.
# discountTotalAsMoney: Money; Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc.
# taxTotalAsMoney: Money; Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc.
# surchargeTotalAsMoney: Money; Gets the surcharge total as a Money object. Represents the surcharge total.
# totalAsMoney: Money; 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.
# invoices: Collection; Get all invoices linked to this order (Order, Checkout)
# currencyCode: string; Get currency code
# id: ?int
# uuid: ?string
# externalId: ?string
# comments: ?string
# data: ?array
# appliedDiscounts: array; Metadata of the applied discounts.
# discountCodes: array; List of the applied discount codes.
# shippingTotal: ?string; Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# handlingTotal: ?string; Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# insuranceTotal: ?string; Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# discountTotal: ?string; Represents the sum of discount values across all line items, including shipping, handling, etc.
# taxTotal: ?string; Represents the sum of tax values across all line items, including shipping, handling, etc.
# surchargeTotal: ?string; Represents the surcharge total.
# total: ?string; Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total.
# created: ?DateTime; Date the record was created.
# modified: ?DateTime; Last modification date for the record.
# billingAddress: ?Address
# deliveryAddress: ?Address
# currency: ?Currency
# person: ?Person
# site: ?Site
# items: ?Collection<Item>
# fulfillments: ?Collection<Fulfillment>
# metadataFieldValues: ?Collection<MetadataFieldValue>
# sourceEntity: ?string; Get the source record entity
# sourceUuid: ?string; Get the source record uuid
# discountLogs: ?Collection<Log>

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 53

Take no arguments.

# getFulfillmentStatusLabels(): array; Gets all available fulfillment statuses with their labels
# getFulfillmentStatusDisplay(): string; Gets fulfillment status display label
# getFinancialStatusLabels(): array; Gets all available financial statuses with their labels
# getFinancialStatusDisplay(): string; Gets financial status display label
# getRefundedTotalAsMoney(): Money; Get the amount refunded
# isRefundable(): bool; Is the order refundable?
# getHateoasLinks() Not in Templates: array; Get the HATEOAS links for the record
# getEditUrl() Not in Templates: ?string; Get the url for editing the record.
# getNumber(): ?string
# getOrdered(): ?DateTime; The time which order was placed
# getFinancialStatus(): ?string; Set the financial status of the order. Values include: unpaid, authorized, partially_paid, paid, partially_refunded, refunded, voided.
# getFulfillmentStatus(): ?string; Set the fulfillment status of the order. Values include: none, pending, partial, fulfilled, completed.
# getRefunds(): ?Collection<Refund>
# getItemTotalAsMoney(): Money; Gets the item total as a Money object. Represents the sum of all items' Amount values.
# getShippingTotalAsMoney(): Money; 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.
# getHandlingTotalAsMoney(): Money; 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.
# getInsuranceTotalAsMoney(): Money; 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.
# getDiscountTotalAsMoney(): Money; Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotalAsMoney(): Money; Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotalAsMoney(): Money; Gets the surcharge total as a Money object. Represents the surcharge total.
# getTotalAsMoney(): Money; 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.
# getInvoices(): Collection; Get all invoices linked to this order (Order, Checkout)
# getCurrencyCode(): string; Get currency code
# getId(): ?int
# getUuid(): ?string
# getExternalId(): ?string
# getComments(): ?string
# getData(): ?array
# getAppliedDiscounts(): array; Metadata of the applied discounts.
# getDiscountCodes(): array; List of the applied discount codes.
# getShippingTotal(): ?string; Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total.
# getHandlingTotal(): ?string; Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total.
# getInsuranceTotal(): ?string; Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total.
# getDiscountTotal(): ?string; Represents the sum of discount values across all line items, including shipping, handling, etc.
# getTaxTotal(): ?string; Represents the sum of tax values across all line items, including shipping, handling, etc.
# getSurchargeTotal(): ?string; Represents the surcharge total.
# getTotal(): ?string; Represents the final value calculated as Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total.
# getCreated(): ?DateTime; Date the record was created.
# getModified(): ?DateTime; Last modification date for the record.
# getBillingAddress(): ?Address
# getDeliveryAddress(): ?Address
# getCurrency(): ?Currency
# getPerson(): ?Person
# getSite(): ?Site
# getItems(): ?Collection<Item>
# getFulfillments(): ?Collection<Fulfillment>
# getMetadataFieldValues(): ?Collection<MetadataFieldValue>
# getSourceEntity(): ?string; Get the source record entity
# getSourceUuid(): ?string; Get the source record uuid
# getDiscountLogs(): ?Collection<Log>
# getUnassignedItems() Admin only: array; The order's items, or the part of each item's quantity, that no active fulfillment covers Derived from quantities, so nothing is stored: the item's quantity minus what its lines in non-cancelled fulfillments hold. The items of a cancelled fulfillment come back here until they are placed again, and so does anything a fulfillment never included.
# isDeliveredDigitally() Admin only: bool; Whether the order had nothing to ship and is complete: it has fulfillments, and every one has a nothing-to-ship method and is delivered The order page then lists the items without fulfillment tracking - no fulfillment badge, cards or packing slips. An order still waiting on one of them keeps its cards, so an admin can mark it delivered; so does one with a cancelled fulfillment, whose items are unassigned and need placing again. Iterates the order's fulfillments, so it must not be called from inside a loop over them.
# getDeliveredDigitallyAt() Admin only: ?DateTime; When the order's nothing-to-ship fulfillments were delivered: the latest of their delivered times Iterates the order's fulfillments, so it must not be called from inside a loop over them.

Methods 2

Take arguments. The API serialises only getters that need none.

# hasModelMethod(string $methodName) Admin only: bool
# get(string $propertyName, array $parameters) Admin only: void

Objects ReferenceGenerated from the platform, so it is always current

API ReferenceEvery REST endpoint, in cURL, PHP, Python and JavaScript