Skip to main content
PUT
Set a store's precedence settings

Authorizations

X-API-Key
string
header
required

Path Parameters

store
string
required

Body

application/json

New precedence settings for one store.

The order you send replaces your settings wholesale: default_order is the order every field resolves by, and field_overrides names the fields that depart from it. Omitting field_overrides removes every override.

Both may only reorder or restrict the sources the store declares — a name the store does not declare is refused, so a precedence change can never introduce a source or a field. Names are limited to letters, digits and underscores.

default_order
string[]
required

The order every field resolves by unless it is overridden. The first source in the order that asserts a value wins, and the order is also the list of sources allowed to write.

Maximum array length: 64
Maximum string length: 64
field_overrides
Field Overrides · object

Per-field orders that depart from the default, keyed by field name. A field absent here uses default_order.

Response

Successful Response

One store's precedence settings, with their version and recompute state.

This is the standalone precedence resource. The store detail response carries the same order and overrides as a nested fragment; this one adds the version stamp, when it last moved, and how much of the store is still catching up.

store
string
required

The store these settings belong to, by its URL slug.

default_order
string[]
required

The order every field resolves by unless it is overridden.

config_version
integer
required

Version of these settings. It increases on every change, including a change that reverts to the defaults. Every record records the version its resolved view was computed with, which is what makes a view left behind by a precedence change detectable — and what lets a resolved value be explained after the fact.

recompute
StoreRecomputeResponse · object
required

Whether every record's resolved view reflects the current precedence.

Changing precedence invalidates the resolved views computed under the old settings, and they are recomputed in the background. While that is running, bulk queries legitimately mix records resolved under the old precedence with records resolved under the new one. pending reaching zero is how you know the window has closed.

field_overrides
Field Overrides · object

Per-field orders that depart from the default. A field absent here uses default_order.

updated_at
string<date-time> | null

When these settings last changed. Null means they have never been changed and are the store's shipped defaults.