Skip to main content

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.

Required scope: customers:read

Grant 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_enabled is true, the availability shown to portal buyers (catalog, product pages, inventory feed) is reduced — holdback_mode percent exposes holdback_percent % of available-to-sell, reserve subtracts holdback_reserve_qty units. 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) or portal (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​

OK

Response Headers
    Content-Type