Skip to main content
PUT
Update order settings

Authorizations

x-api-key
string
header
required

Your Upstack API key. Starts with upstack_.

x-pixel-id
string
header
required

The pixel id the request targets.

Body

application/json

Which orders count, how refunds are dated, and which orders are excluded. Applies to every revenue, attribution, and cohort figure.

countPendingOrders
boolean
required

Include pending orders in revenue / attribution metrics.

countVoidedOrders
boolean
required

Include voided orders in revenue / attribution metrics.

refundDateAttribution
enum<string>
required

How refunds are dated for revenue attribution.

  • refund_date — matches Shopify, defaults to this.
  • order_date — attribute the refund to the original order date.
Available options:
refund_date,
order_date
exclusionFilters
object[]
required
Maximum array length: 50

Response

The updated order settings (with server-assigned ids and timestamps).

orderSettings
object
required

Which orders count, how refunds are dated, and which orders are excluded. Applies to every revenue, attribution, and cohort figure.