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.

Not yet available to API tokens

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

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.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.