Instance / Config Properties
Instance configuration is held in two forms and exposed via the Instance Properties and Instance Attributes APIs.
Instance Properties are simple name/value string pairs (value up to 1000 chars, typically JSON). A “type” concept (STRING, NUMBER, BOOLEAN, JSON, DATE) surfaces in the API for documentation, though the stored value is a string. Well-known keys read by the service:
| Property key | Purpose |
|---|---|
sales_channels |
JSON list of enabled sales channels |
allocation_strategies |
JSON list of allowed allocation strategies |
location_types |
JSON list of valid location types for the instance (allows dynamic types beyond the base enum) |
fulfillment_capabilities |
JSON list of valid fulfillment capabilities |
use_strategy_based_availability |
Boolean flag; default true (capacity management) |
pluginConfig |
Configuration that selects per-instance validation extensions. Writing this key deliberately skips the extension point to avoid lock-out |
Instance Attributes are typed custom metadata with dataType in {TEXT, NUMBER, BOOLEAN, DATE, EMAIL, URL, JSON}, plus is_required, is_active, and sort_order.
Revision History
2026-08-05 | AN – Page created and uploaded the contents