Update a channel

PATCH

/platform/v1/channels/{channel_id}

curl --request PATCH \
  --url https://api.eu1.luigisbox.ai/platform/v1/channels/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "attribute_aliases": { "additionalProperty": "example" }, "name": "example", "visibility_filter": { "$and": [ { "brand": { "in": [ "nike", "adidas" ] } }, { "lbx:price": { "gte": 50, "lte": 200 } }, { "$or": [ { "condition": { "eq": "new" } }, { "warranty_months": { "gte": 12 } } ] }, { "$not": { "material": { "eq": "leather" } } }, { "image": { "exists": true } } ] } }'

Authorizations

• HTTPBearer

Parameters

Path Parameters

channel_id

required

Channel Id

string

Request Body ^required

Media type application/json

ChannelUpdate

Partial update. Only fields the body names are applied.

visibility_filter is the one clearable field: an explicit null removes the filter. Sending any other field as null is rejected with 422.

object

attribute_aliases

Attribute Aliases

Channel-facing name (key) bound to a catalog field (value), e.g. {"product_name": "title"}. A request naming product_name resolves to catalog title and the response comes back keyed product_name, while the catalog field stays addressable under its own name. A key is checked against the catalog’s fields only as it is written: should the catalog later gain a field of that name, that field takes the name back and the alias stops taking effect. See Attribute aliases for the full contract.

object

key

additional properties

string

name

Name

string

>= 1 characters <= 256 characters

visibility_filter

Any of:

Visibility Filter

One of:

FilterGroup

FilterGroup

A filter tree in group syntax: a boolean operator over leaves and nested groups.

not holds exactly one child. An empty and constrains nothing and an empty or matches nothing; each endpoint says whether it accepts either.

object

conditions

Conditions

Leaf conditions and nested groups.

Array

One of:

FilterCondition

FilterCondition

One leaf of a group-syntax tree: a field compared against a value.

object

field

required

Field

Object field the condition reads.

string

on_missing

Any of:

DynamicFilterMissingPolicy

DynamicFilterMissingPolicy

What a condition reading its value from the request’s anchors does when none carries the attribute.

fail_closed (the default) makes the whole filter tree match nothing. ignore drops the condition instead, leaving the rest of the tree in force.

string

Allowed values: fail_closed ignore

null

null

operator

required

FilterOperator

Comparison operator.

string

Allowed values: eq neq gt gte lt lte in not_in matches starts_with ends_with range exists

source

FilterSource

Provenance of the condition; stamped by the system, never read from a client.

string

default: request

Allowed values: request collection surface autofilter business_rule visibility

value

Value

Literal to compare against, or a trigger reference {trigger_ref: ...}; a scalar for eq/neq and the comparisons, a non-empty list for in/not_in, absent for exists.

value_from

Any of:

FilterValueFrom

FilterValueFrom

Where a dynamic condition reads its value: an attribute of the request’s anchors.

object

anchor_attribute

required

Anchor Attribute

Anchor attribute whose value the condition compares against.

string

null

null

FilterGroup

object recursive

operator

required

BooleanOperator

Boolean combinator applied to conditions.

string

Allowed values: and or not

ConfigFilter

One of:

object

A group node: exactly one of $and, $or, $not.

object

>= 1 properties <= 1 properties

$and

Nodes that must all match.

Array

>= 1 items <= 100 items

One of:

recursive object

object recursive

object

A condition node: field names mapped to operator objects; sibling fields combine as AND.

object

>= 1 properties <= 100 properties

key

additional properties

Operators applied to one field. Several operators in one object combine as AND.

object

>= 1 properties

eq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

exists

boolean

gt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

gte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

matches

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

neq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

not_in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

$not

One of:

recursive object

object recursive

object

A condition node: field names mapped to operator objects; sibling fields combine as AND.

object

>= 1 properties <= 100 properties

key

additional properties

Operators applied to one field. Several operators in one object combine as AND.

object

>= 1 properties

eq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

exists

boolean

gt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

gte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

matches

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

neq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

not_in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

$or

Nodes of which at least one must match.

Array

>= 1 items <= 100 items

One of:

recursive object

object recursive

object

A condition node: field names mapped to operator objects; sibling fields combine as AND.

object

>= 1 properties <= 100 properties

key

additional properties

Operators applied to one field. Several operators in one object combine as AND.

object

>= 1 properties

eq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

exists

boolean

gt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

gte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

matches

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

neq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

not_in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

object

A condition node: field names mapped to operator objects; sibling fields combine as AND.

object

>= 1 properties <= 100 properties

key

additional properties

Operators applied to one field. Several operators in one object combine as AND.

object

>= 1 properties

eq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

exists

boolean

gt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

gte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

matches

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

neq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

not_in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

null

null

Responses

200

Successful Response

Media type application/json

Channel

object

attribute_aliases

required

Attribute Aliases

Channel-facing name (key) bound to a catalog field (value), e.g. {"product_name": "title"}. A request naming product_name resolves to catalog title and the response comes back keyed product_name, while the catalog field stays addressable under its own name. A key is checked against the catalog’s fields only as it is written: should the catalog later gain a field of that name, that field takes the name back and the alias stops taking effect. See Attribute aliases for the full contract.

object

key

additional properties

string

catalog_id

required

Catalog Id

string

created_at

required

Created At

string format: date-time

id

required

Id

string

name

required

Name

string

updated_at

required

Updated At

string format: date-time

visibility_filter

required

Any of:

FilterGroup

FilterGroup

A filter tree in group syntax: a boolean operator over leaves and nested groups.

not holds exactly one child. An empty and constrains nothing and an empty or matches nothing; each endpoint says whether it accepts either.

object

conditions

Conditions

Leaf conditions and nested groups.

Array

One of:

FilterCondition

FilterCondition

One leaf of a group-syntax tree: a field compared against a value.

object

field

required

Field

Object field the condition reads.

string

on_missing

Any of:

DynamicFilterMissingPolicy

DynamicFilterMissingPolicy

What a condition reading its value from the request’s anchors does when none carries the attribute.

fail_closed (the default) makes the whole filter tree match nothing. ignore drops the condition instead, leaving the rest of the tree in force.

string

Allowed values: fail_closed ignore

null

null

operator

required

FilterOperator

Comparison operator.

string

Allowed values: eq neq gt gte lt lte in not_in matches starts_with ends_with range exists

source

FilterSource

Provenance of the condition; stamped by the system, never read from a client.

string

default: request

Allowed values: request collection surface autofilter business_rule visibility

value

Value

Literal to compare against, or a trigger reference {trigger_ref: ...}; a scalar for eq/neq and the comparisons, a non-empty list for in/not_in, absent for exists.

value_from

Any of:

FilterValueFrom

FilterValueFrom

Where a dynamic condition reads its value: an attribute of the request’s anchors.

object

anchor_attribute

required

Anchor Attribute

Anchor attribute whose value the condition compares against.

string

null

null

FilterGroup

object recursive

operator

required

BooleanOperator

Boolean combinator applied to conditions.

string

Allowed values: and or not

ConfigFilter

One of:

object

A group node: exactly one of $and, $or, $not.

object

>= 1 properties <= 1 properties

$and

Nodes that must all match.

Array

>= 1 items <= 100 items

One of:

recursive object

object recursive

object

A condition node: field names mapped to operator objects; sibling fields combine as AND.

object

>= 1 properties <= 100 properties

key

additional properties

Operators applied to one field. Several operators in one object combine as AND.

object

>= 1 properties

eq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

exists

boolean

gt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

gte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

matches

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

neq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

not_in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

$not

One of:

recursive object

object recursive

object

A condition node: field names mapped to operator objects; sibling fields combine as AND.

object

>= 1 properties <= 100 properties

key

additional properties

Operators applied to one field. Several operators in one object combine as AND.

object

>= 1 properties

eq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

exists

boolean

gt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

gte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

matches

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

neq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

not_in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

$or

Nodes of which at least one must match.

Array

>= 1 items <= 100 items

One of:

recursive object

object recursive

object

A condition node: field names mapped to operator objects; sibling fields combine as AND.

object

>= 1 properties <= 100 properties

key

additional properties

Operators applied to one field. Several operators in one object combine as AND.

object

>= 1 properties

eq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

exists

boolean

gt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

gte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

matches

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

neq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

not_in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

object

A condition node: field names mapped to operator objects; sibling fields combine as AND.

object

>= 1 properties <= 100 properties

key

additional properties

Operators applied to one field. Several operators in one object combine as AND.

object

>= 1 properties

eq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

exists

boolean

gt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

gte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lt

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

lte

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

matches

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

neq

Any of:

string | number | integer | boolean | null

string | number | integer | boolean | null

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

not_in

Any of:

Array<string | number | integer | boolean | null>

Array<string | number | integer | boolean | null>

>= 1 items

object

A value resolved from the request’s trigger attributes at evaluation time.

object

index

integer

n

integer

>= 1

path

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

select

string

Allowed values: first last all first_n last_n at_index all_but_first all_but_last

trigger_ref

required

string

/^trigger\./

object

A value read from the request’s anchor objects at evaluation time.

object

on_missing

What the condition does when no anchor carries the attribute; defaults to fail_closed.

string

Allowed values: fail_closed ignore

value_from

required

object

anchor_attribute

required

string

>= 1 characters

null

null

Example

{
  "visibility_filter": {
    "$and": [
      {
        "brand": {
          "in": [
            "nike",
            "adidas"
          ]
        }
      },
      {
        "lbx:price": {
          "gte": 50,
          "lte": 200
        }
      },
      {
        "$or": [
          {
            "condition": {
              "eq": "new"
            }
          },
          {
            "warranty_months": {
              "gte": 12
            }
          }
        ]
      },
      {
        "$not": {
          "material": {
            "eq": "leather"
          }
        }
      },
      {
        "image": {
          "exists": true
        }
      }
    ]
  }
}

401

Missing or invalid credentials

Media type application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

null

null

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string

string

null

null

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

403

Authenticated but not permitted

Media type application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

null

null

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string

string

null

null

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

404

Resource not found

Media type application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

null

null

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string

string

null

null

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

409

State conflict

Media type application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

null

null

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string

string

null

null

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

422

Request validation failed

Media type application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

null

null

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string

string

null

null

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

503

The catalog’s field types could not be read, so visibility_filter and attribute_aliases could not be checked against the catalog’s fields. Retryable: Retry-After carries the number of seconds to wait.

Media type application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

null

null

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string

string

null

null

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

Headers

Retry-After

integer

Seconds to wait before retrying the write.