Skip to main content

Get Sales Order

GET 
/api/v2/sales-orders/:salesOrder

Returns core sales order data for the V2 show page. Includes essential fields, addresses, channel info, totals, counts, custom fields, financial lines, tags, discounts, credits, RMAs, and purchase orders.

Required scope: orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Line items are loaded separately via the lineItems endpoint for parallel loading.

Also returns the top-level flag use_sales_order_line_nominal_codes (boolean) — sibling to data — indicating whether the per-line nominal code editor should be enabled in the UI. Mirrors the accounting.use_sales_order_line_nominal_codes config value.

Payment / credit totals:

  • total_paid: aggregated sum of payments.amount for the order — lets the UI render Paid/Balance Due without lazy-loading the payments array.
  • Each entry in sales_credits[] includes refund_payments_total (sum of cash/card refunds against the credit, always positive), applied_to_other_total (sum of credit consumed by Loop Returns EXC-* exchange orders, always positive), fees_retained_total (sum of fees Loop withheld out of the customer's credit — return shipping, restocking, etc., always positive), and outstanding_amount (= total − refund_payments_total − applied_to_other_total − fees_retained_total, clamped to zero). The frontend uses outstanding_amount for the Credits line so partially-refunded credits no longer double-count against Balance Due. Each credit also includes metadata (nullable object) — a minimal source subset {source, sales_channel_refund_id} used to render the channel-source chip (e.g. eBay refund-synced credits); null for manually created credits.

Authentication: Requires Bearer token.

Address override fields: shipping_overridden_at is an ISO-8601 UTC timestamp (or null) set when an operator manually corrects the ship-to/billing address; is_shipping_overridden is the boolean equivalent. When set, sales-channel resyncs (e.g. Amazon) will not overwrite the corrected inline address columns.

Request​

Responses​

OK