Skip to main content

List Sales Order Shipping Estimates

GET 

/api/sales-orders/:salesOrder/shipping-estimates

Lists the latest 10 shipping estimates run on the sales order, newest first.

Required scope: orders:read

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

Each row: id, context (sales_order, or portal for a rate priced at portal checkout), status (see Estimate Sales Order Shipping), mode (production or test key), currency_code, options_count, selected_option_key (null when no rate was applied), service_label and cost (the applied rate, else the cheapest one), charged_amount, applied, outcome (line_added, cost_only when it was recorded as cost only, or not_applied), applied_financial_line_id, quote_line_id (always null here), adjustments (how the charge was worked out: cost, markup_type, markup_value, charge, overridden, replaced_financial_line_id, shipping_method_id; record_only when cost only) and created_at.

Authentication: Requires Bearer token. Scope: orders (read).

Request​

Responses​

OK

Response Headers
    Content-Type