Skip to main content

Update Portal Settings

PUT 
/api/admin/portal/settings

Update the tenant-wide customer portal settings.

Not yet available to API tokens

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

Body fields:

  • allow_backorder (required, boolean): the portal-wide default for whether buyers can order more than is in stock. Every account inherits it unless that account sets its own allow_backorder, and an individual product overrides both. Ships enabled.
  • min_order_value_enabled (required, boolean): master switch for a tenant-wide minimum order value. When false there is no default minimum (an account may still set its own).
  • min_order_value (required when min_order_value_enabled is true; number, greater than zero; otherwise nullable): the default minimum order subtotal applied to every account that hasn't set its own. A location's own minimum overrides this default. Stored as null whenever min_order_value_enabled is false. 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​

OK

Response Headers
    Content-Type