Replace order settings
curl --request PUT \
--url https://api.upstackdata.com/accounts/api/account/settings/order \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-pixel-id: <api-key>' \
--data '
{
"countPendingOrders": false,
"countVoidedOrders": false,
"refundDateAttribution": "refund_date",
"exclusionFilters": [
{
"name": "Exclude POS",
"enabled": true,
"conditionGroups": [
{
"logic": "and",
"conditions": [
{
"field": "sourceName",
"operator": "not_equals",
"value": "pos"
}
]
}
]
}
]
}
'import requests
url = "https://api.upstackdata.com/accounts/api/account/settings/order"
payload = {
"countPendingOrders": False,
"countVoidedOrders": False,
"refundDateAttribution": "refund_date",
"exclusionFilters": [
{
"name": "Exclude POS",
"enabled": True,
"conditionGroups": [
{
"logic": "and",
"conditions": [
{
"field": "sourceName",
"operator": "not_equals",
"value": "pos"
}
]
}
]
}
]
}
headers = {
"x-api-key": "<api-key>",
"x-pixel-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
'x-pixel-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
countPendingOrders: false,
countVoidedOrders: false,
refundDateAttribution: 'refund_date',
exclusionFilters: [
{
name: 'Exclude POS',
enabled: true,
conditionGroups: [
{
logic: 'and',
conditions: [{field: 'sourceName', operator: 'not_equals', value: 'pos'}]
}
]
}
]
})
};
fetch('https://api.upstackdata.com/accounts/api/account/settings/order', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.upstackdata.com/accounts/api/account/settings/order",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'countPendingOrders' => false,
'countVoidedOrders' => false,
'refundDateAttribution' => 'refund_date',
'exclusionFilters' => [
[
'name' => 'Exclude POS',
'enabled' => true,
'conditionGroups' => [
[
'logic' => 'and',
'conditions' => [
[
'field' => 'sourceName',
'operator' => 'not_equals',
'value' => 'pos'
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-pixel-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.upstackdata.com/accounts/api/account/settings/order"
payload := strings.NewReader("{\n \"countPendingOrders\": false,\n \"countVoidedOrders\": false,\n \"refundDateAttribution\": \"refund_date\",\n \"exclusionFilters\": [\n {\n \"name\": \"Exclude POS\",\n \"enabled\": true,\n \"conditionGroups\": [\n {\n \"logic\": \"and\",\n \"conditions\": [\n {\n \"field\": \"sourceName\",\n \"operator\": \"not_equals\",\n \"value\": \"pos\"\n }\n ]\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-pixel-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.upstackdata.com/accounts/api/account/settings/order")
.header("x-api-key", "<api-key>")
.header("x-pixel-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"countPendingOrders\": false,\n \"countVoidedOrders\": false,\n \"refundDateAttribution\": \"refund_date\",\n \"exclusionFilters\": [\n {\n \"name\": \"Exclude POS\",\n \"enabled\": true,\n \"conditionGroups\": [\n {\n \"logic\": \"and\",\n \"conditions\": [\n {\n \"field\": \"sourceName\",\n \"operator\": \"not_equals\",\n \"value\": \"pos\"\n }\n ]\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upstackdata.com/accounts/api/account/settings/order")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"countPendingOrders\": false,\n \"countVoidedOrders\": false,\n \"refundDateAttribution\": \"refund_date\",\n \"exclusionFilters\": [\n {\n \"name\": \"Exclude POS\",\n \"enabled\": true,\n \"conditionGroups\": [\n {\n \"logic\": \"and\",\n \"conditions\": [\n {\n \"field\": \"sourceName\",\n \"operator\": \"not_equals\",\n \"value\": \"pos\"\n }\n ]\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"orderSettings": {
"countPendingOrders": true,
"countVoidedOrders": true,
"exclusionFilters": [
{
"name": "Exclude POS",
"enabled": true,
"conditionGroups": [
{
"conditions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}ACCOUNT
Replace order settings
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.
PUT
/
accounts
/
api
/
account
/
settings
/
order
Replace order settings
curl --request PUT \
--url https://api.upstackdata.com/accounts/api/account/settings/order \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-pixel-id: <api-key>' \
--data '
{
"countPendingOrders": false,
"countVoidedOrders": false,
"refundDateAttribution": "refund_date",
"exclusionFilters": [
{
"name": "Exclude POS",
"enabled": true,
"conditionGroups": [
{
"logic": "and",
"conditions": [
{
"field": "sourceName",
"operator": "not_equals",
"value": "pos"
}
]
}
]
}
]
}
'import requests
url = "https://api.upstackdata.com/accounts/api/account/settings/order"
payload = {
"countPendingOrders": False,
"countVoidedOrders": False,
"refundDateAttribution": "refund_date",
"exclusionFilters": [
{
"name": "Exclude POS",
"enabled": True,
"conditionGroups": [
{
"logic": "and",
"conditions": [
{
"field": "sourceName",
"operator": "not_equals",
"value": "pos"
}
]
}
]
}
]
}
headers = {
"x-api-key": "<api-key>",
"x-pixel-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
'x-pixel-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
countPendingOrders: false,
countVoidedOrders: false,
refundDateAttribution: 'refund_date',
exclusionFilters: [
{
name: 'Exclude POS',
enabled: true,
conditionGroups: [
{
logic: 'and',
conditions: [{field: 'sourceName', operator: 'not_equals', value: 'pos'}]
}
]
}
]
})
};
fetch('https://api.upstackdata.com/accounts/api/account/settings/order', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.upstackdata.com/accounts/api/account/settings/order",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'countPendingOrders' => false,
'countVoidedOrders' => false,
'refundDateAttribution' => 'refund_date',
'exclusionFilters' => [
[
'name' => 'Exclude POS',
'enabled' => true,
'conditionGroups' => [
[
'logic' => 'and',
'conditions' => [
[
'field' => 'sourceName',
'operator' => 'not_equals',
'value' => 'pos'
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-pixel-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.upstackdata.com/accounts/api/account/settings/order"
payload := strings.NewReader("{\n \"countPendingOrders\": false,\n \"countVoidedOrders\": false,\n \"refundDateAttribution\": \"refund_date\",\n \"exclusionFilters\": [\n {\n \"name\": \"Exclude POS\",\n \"enabled\": true,\n \"conditionGroups\": [\n {\n \"logic\": \"and\",\n \"conditions\": [\n {\n \"field\": \"sourceName\",\n \"operator\": \"not_equals\",\n \"value\": \"pos\"\n }\n ]\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-pixel-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.upstackdata.com/accounts/api/account/settings/order")
.header("x-api-key", "<api-key>")
.header("x-pixel-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"countPendingOrders\": false,\n \"countVoidedOrders\": false,\n \"refundDateAttribution\": \"refund_date\",\n \"exclusionFilters\": [\n {\n \"name\": \"Exclude POS\",\n \"enabled\": true,\n \"conditionGroups\": [\n {\n \"logic\": \"and\",\n \"conditions\": [\n {\n \"field\": \"sourceName\",\n \"operator\": \"not_equals\",\n \"value\": \"pos\"\n }\n ]\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upstackdata.com/accounts/api/account/settings/order")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"countPendingOrders\": false,\n \"countVoidedOrders\": false,\n \"refundDateAttribution\": \"refund_date\",\n \"exclusionFilters\": [\n {\n \"name\": \"Exclude POS\",\n \"enabled\": true,\n \"conditionGroups\": [\n {\n \"logic\": \"and\",\n \"conditions\": [\n {\n \"field\": \"sourceName\",\n \"operator\": \"not_equals\",\n \"value\": \"pos\"\n }\n ]\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"orderSettings": {
"countPendingOrders": true,
"countVoidedOrders": true,
"exclusionFilters": [
{
"name": "Exclude POS",
"enabled": true,
"conditionGroups": [
{
"conditions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}Authorizations
Your Upstack API key. Starts with upstack_.
The pixel id the request targets.
Body
application/json
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.
Available options:
refund_date, order_date Maximum array length:
50Show child attributes
Show child attributes
Response
The 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.
Show child attributes
Show child attributes
Was this page helpful?
⌘I