ModelCheckouts module

Checkout

A model in the Checkouts module, with 45 members for templates, 45 API properties and 45 members for admin templates.

Checkouts\Models\Frontend\Checkout Checkouts\Models\Api\Checkout Checkouts\Models\Backend\Checkout Also in Checkouts: RestrictedPerson

Templates view

Properties 45

Take no arguments.

# getPerson(): ?Person
# isReadyForPayment(): bool; 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.
# isFullyPaid(): bool; Has the checkout been fully paid? This checks if there are payment/s, or at least pre-authorizations, covering the checkout total.
# getSettledAmountAsMoney(): Money; Gets the settled amount as a Money object. Represents the total committed across the checkout's invoices: full total for paid invoices, authorized amount for open invoices. Draft and voided invoices are excluded.
# getSourceRecord(): ?Model; Gets the record the checkout was created from: a cart or a quote. Returns null when the checkout is split from its cart, or when the source record no longer exists.
# hasSourceRecord(): bool; Tells whether the checkout has a record it was created from
# getCart(): ?Cart; Gets the cart the checkout was created from. Returns null when the checkout is split from its cart or created from a quote.
# hasCart(): bool; Tells whether the checkout was created from a cart and is not split from it
# getQuote(): ?Quote; Gets the quote the checkout was created from. Returns null when the checkout was created from a cart.
# hasQuote(): bool; Tells whether the checkout was created from a quote
# 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
# 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
# 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 45

Read-only values on the record.

# person: ?Person
# readyForPayment: bool; 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.
# fullyPaid: bool; Has the checkout been fully paid? This checks if there are payment/s, or at least pre-authorizations, covering the checkout total.
# settledAmountAsMoney: Money; Gets the settled amount as a Money object. Represents the total committed across the checkout's invoices: full total for paid invoices, authorized amount for open invoices. Draft and voided invoices are excluded.
# sourceRecord: ?Model; Gets the record the checkout was created from: a cart or a quote. Returns null when the checkout is split from its cart, or when the source record no longer exists.
# sourceRecord: bool; Tells whether the checkout has a record it was created from
# cart: ?Cart; Gets the cart the checkout was created from. Returns null when the checkout is split from its cart or created from a quote.
# cart: bool; Tells whether the checkout was created from a cart and is not split from it
# quote: ?Quote; Gets the quote the checkout was created from. Returns null when the checkout was created from a cart.
# quote: bool; Tells whether the checkout was created from a quote
# 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
# 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
# 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 45

Take no arguments.

# isReadyForPayment(): bool; 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.
# isFullyPaid(): bool; Has the checkout been fully paid? This checks if there are payment/s, or at least pre-authorizations, covering the checkout total.
# getSettledAmountAsMoney(): Money; Gets the settled amount as a Money object. Represents the total committed across the checkout's invoices: full total for paid invoices, authorized amount for open invoices. Draft and voided invoices are excluded.
# getSourceRecord(): ?Model; Gets the record the checkout was created from: a cart or a quote. Returns null when the checkout is split from its cart, or when the source record no longer exists.
# hasSourceRecord(): bool; Tells whether the checkout has a record it was created from
# getCart(): ?Cart; Gets the cart the checkout was created from. Returns null when the checkout is split from its cart or created from a quote.
# hasCart(): bool; Tells whether the checkout was created from a cart and is not split from it
# getQuote(): ?Quote; Gets the quote the checkout was created from. Returns null when the checkout was created from a cart.
# hasQuote(): bool; Tells whether the checkout was created from a quote
# 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
# 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>

Objects ReferenceGenerated from the platform, so it is always current

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

Checkout

Templates view

Properties 45

API & Jobs view

Properties 45

Admin view

Properties 45