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.
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 location that hasn't set its own; null when disabled.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Content-Type
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.