Get Portal Settings
GET/api/admin/portal/settings
Get the tenant-wide customer portal settings: the backorder master switch and the default minimum order value.
customers:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Response fields:
-
allow_backorder (boolean): backorder master switch.
-
min_order_value_enabled (boolean): whether a tenant-wide default minimum order value is enforced.
-
min_order_value (number|null): the default minimum order subtotal applied to every account that hasn't set its own; null when disabled. Holdback: when
holdback_enabledis true, the availability shown to portal buyers (catalog, product pages, inventory feed) is reduced —holdback_modepercentexposesholdback_percent% of available-to-sell,reservesubtractsholdback_reserve_qtyunits. Display-layer only; channel sync is unaffected. -
shipping_free_threshold (number|null, read-only here): the portal-wide free-shipping threshold, edited with Update Portal Shipping Settings.
Order history & quotes:
- order_history_scope:
all_channels(default — buyers see every order the customer has, minus another channel's drafts) orportal(only orders placed in the portal). - guest_rfq_enabled: open the public Request a quote page (no account needed). Default false.
- guest_rfq_note: optional plain-text intro above that form, max 2000; blank clears it.
- rfq_pricing_hidden_until_sent: hide a requested quote's prices from the buyer until staff send it. Default false. All four are optional on update; an omitted key keeps its value.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.