Skip to main content

Update Portal Shipping Settings

PUT 
/api/admin/portal/shipping

Save the portal shipping settings in one transaction. Methods not listed keep their pricing. Settings that do not apply to a method's mode are cleared (a flat method loses its services and markup; a live-rate method loses its flat amount). Returns the same payload as Get Portal Shipping Settings.

Not yet available to API tokens

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

Request body:

  • methods (array, required, may be empty, max 200). Each:
    • shipping_method_id (integer, required, distinct, an existing shipping method).
    • mode (required): live_rate, flat, free or on_review. A pickup method can't be live_rate.
    • flat_amount (number 0–1000000; required when mode is flat), flat_basis (order, unit or case; default order).
    • services (array, max 20; at least one required for live_rate): carrier (string, required, max 60), service (string, required, max 60), carrier_account_id (string, optional, max 80).
    • handling_fee (number 0–100000), markup_percent (number 0–500), rounding (none, 0.5, 1), max_charge (number 0–1000000) — live rate only.
    • min_subtotal, max_subtotal (number ≥ 0; max must be ≥ min), max_weight_oz (number ≥ 0), origin_warehouse_ids (array of warehouse ids, max 50).
  • free_threshold (number ≥ 0, nullable): 0 or null turns the threshold off.
  • fallback_mode (required): flat or on_review.
  • fallback_amount (number 0–1000000, nullable): required when fallback_mode is flat and any method is live rate.

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

Request​

Responses​

OK

Response Headers
    Content-Type