Replace the account’s order settings in full. PUT-the-whole-config
semantics — any existing exclusion filter not present in the body
is deleted. The server assigns id, createdAt, and updatedAt
on new filters (and on nested groups + conditions); entries that
already carry an id preserve their createdAt and get a bumped
updatedAt.
Strict allowlist at every nesting level — extra keys in the body, in
a filter, in a group, or in a condition are rejected with 400.
Operators must be valid for the chosen field type per
ORDER_EXCLUSION_FIELD_CATALOG (e.g. greater_than on sourceName
is rejected).
Emits an accountUpdated EventBridge event with
actor: cli:{apiKeyPk} and change: { kind: "orderSettings" }.
Required scope: account:write.
Documentation Index
Fetch the complete documentation index at: https://docs.upstackdata.com/llms.txt
Use this file to discover all available pages before exploring further.
Your Upstack API key. Starts with upstack_.
The pixel id the request targets.
Account-wide order analytics config. Drives every revenue, attribution,
and cohort number across the dashboard and the public query API. Defaults
when unset: countPendingOrders=false, countVoidedOrders=false,
refundDateAttribution=refund_date, exclusionFilters=[].
PUT semantics are whole-object replace — any existing filter not present in the PUT body is deleted. Max 50 filters per account.
Include pending orders in revenue / attribution metrics.
Include voided orders in revenue / attribution metrics.
How refunds are dated for revenue attribution.
refund_date — matches Shopify, defaults to this.order_date — attribute the refund to the original order date.refund_date, order_date 50The updated order settings (with server-assigned ids and timestamps).
Account-wide order analytics config. Drives every revenue, attribution,
and cohort number across the dashboard and the public query API. Defaults
when unset: countPendingOrders=false, countVoidedOrders=false,
refundDateAttribution=refund_date, exclusionFilters=[].
PUT semantics are whole-object replace — any existing filter not present in the PUT body is deleted. Max 50 filters per account.