Inttegro.Orders.ShippingLineItem (inttegro v0.2.0)

Represents Shipping Line Item data in the Orders API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Manages the complete commercial and payment lifecycle of an order.

Orders bind customer information, immutable commercial terms, line items, totals, payment state, and invoice or receipt documents. Create an order, finalize it when its terms are ready, and then collect or record payment. Payment execution can require a later confirmation step; inspect the returned order and its next action instead of treating the first request as final.

Looking up an order

request = Inttegro.Orders.LookupRequest.new!(order_id: "or_...")

case Inttegro.Orders.lookup(client, request) do
  {:ok, %Inttegro.Orders.Order{status: :completed} = order} ->
    order

  {:ok, order} ->
    {:pending, order.status}

  {:error, %Inttegro.Errors.APIError{} = error} ->
    {:retry_or_reject, error}
end

See the Orders and payments guide for creation, idempotency, confirmation, and hosted checkout.

Summary

Types

t()

The decoded shipping line item value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Orders.ShippingLineItem and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Orders.ShippingLineItem{
  shipping: Inttegro.Orders.ShippingLineItemShipping.t(),
  type: String.t()
}

The decoded shipping line item value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Orders.ShippingLineItem and raises KeyError when a required field is missing.