The authoritative record of a purchase and its payment and fulfillment state.
An order combines immutable line items and totals with customer, invoice, payment, refund, and lifecycle information. Once finalized, commercial terms cannot be changed. Status changes can continue asynchronously, so use lookup or lifecycle notifications rather than trusting a browser redirect as proof of payment.
Summary
Functions
Builds a Inttegro.Orders.Order and raises KeyError when a required field is missing.
Types
@type t() :: %Inttegro.Orders.Order{ canceled_at: String.t() | nil, checkout_settings: Inttegro.Orders.CheckoutSettings.t() | nil, completed_at: String.t() | nil, created_from: Inttegro.Orders.CreatedFrom.t() | nil, custom_data: %{optional(String.t()) => String.t()} | nil, customer: Inttegro.Orders.Customer.t(), expires_at: String.t() | nil, id: String.t(), initiated_at: String.t(), invoice: Inttegro.Invoices.Order.t() | nil, invoice_settings: Inttegro.Invoices.Settings.t() | nil, line_item_group: Inttegro.Orders.LineItemGroup.t() | nil, number: String.t() | nil, paid_at: String.t() | nil, payment: Inttegro.Payments.Payment.t() | nil, payment_due_at: String.t() | nil, payout_settings: %{optional(String.t()) => term()} | nil, receipt_number: String.t() | nil, reference: String.t() | nil, refunds: [Inttegro.Refunds.Refund.t()] | nil, sealed_at: String.t() | nil, shipping: %{optional(String.t()) => term()} | nil, status: Inttegro.Orders.Status.t() }
The decoded order value.
Functions
Builds a Inttegro.Orders.Order and raises KeyError when a required field is missing.