Skip to main content

Get Portal Shipping Settings

GET 
/api/admin/portal/shipping

Get the portal shipping settings: each method's pricing, the free-shipping threshold, the live-rate fallback, and readiness for live rates.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Response (data):

  • methods[]: every shipping method — id, name, full_name, carrier_name, is_pickup, customer_arranges_freight, delivery_min_days, delivery_max_days, included_locations / excluded_locations (country codes), has_pricing (false = never configured, so the default applies: free for buyer-arranged freight, else on review) and pricing:
    • mode: live_rate (carrier rates via EasyPost), flat, free or on_review (calculated on review — the order is placed with shipping_pending_review and you price it later).
    • flat_amount, flat_basis (order, unit or case) — flat mode.
    • services[] (carrier_account_id, carrier, service), handling_fee, markup_percent, rounding (none, 0.5 or 1 — round up to the next 0.50 / 1.00), max_charge — live-rate mode. The cheapest listed service is charged.
    • min_subtotal, max_subtotal, max_weight_oz, origin_warehouse_ids — the method is hidden at checkout outside these limits (any mode).
  • free_threshold (number|null): subtotal at which every method becomes free (an account can override it, or get free shipping outright).
  • fallback_mode (flat|on_review) and fallback_amount: what a live-rate method charges when rates are unavailable.
  • portal_aov (number|null): average portal order value, a guide for the threshold.
  • warehouses[]: id, name of the warehouses a method can ship from.
  • readiness: connected, mode, key_last4, key_error, carrier_accounts[], carrier_accounts_error, products_total, products_with_weight, weight_coverage_percent and missing_weight_products[] (id, sku, name) — live rates need a production EasyPost key, carrier accounts and product weights.

Authentication: Requires Bearer token (staff) with portal management access.

Request​

Responses​

OK

Response Headers
    Content-Type