Get order settings

curl --request GET \
  --url https://api.upstackdata.com/accounts/api/account/settings/order \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'

import requests

url = "https://api.upstackdata.com/accounts/api/account/settings/order"

headers = {
    "x-api-key": "<api-key>",
    "x-pixel-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', 'x-pixel-id': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upstackdata.com/accounts/api/account/settings/order"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-pixel-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "orderSettings": {
    "countPendingOrders": true,
    "countVoidedOrders": true,
    "refundDateAttribution": "refund_date",
    "exclusionFilters": [
      {
        "name": "Exclude POS",
        "enabled": true,
        "conditionGroups": [
          {
            "logic": "and",
            "conditions": [
              {
                "field": "sourceName",
                "operator": "equals",
                "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>"
      ]
    }
  ]
}

ACCOUNT

Get order settings

Return the account’s order settings — count flags for pending / voided orders, refund-date attribution, and the list of exclusion filters that drop matching orders from every analytics query.

Defaults are applied when the account has no stored orderSettings (countPendingOrders=false, countVoidedOrders=false, refundDateAttribution=refund_date, exclusionFilters=[]) so the response shape is always complete.

Required scope: account:read.

GET

accounts

api

account

settings

order

Get order settings

curl --request GET \
  --url https://api.upstackdata.com/accounts/api/account/settings/order \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'

import requests

url = "https://api.upstackdata.com/accounts/api/account/settings/order"

headers = {
    "x-api-key": "<api-key>",
    "x-pixel-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', 'x-pixel-id': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upstackdata.com/accounts/api/account/settings/order"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-pixel-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "orderSettings": {
    "countPendingOrders": true,
    "countVoidedOrders": true,
    "refundDateAttribution": "refund_date",
    "exclusionFilters": [
      {
        "name": "Exclude POS",
        "enabled": true,
        "conditionGroups": [
          {
            "logic": "and",
            "conditions": [
              {
                "field": "sourceName",
                "operator": "equals",
                "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>"
      ]
    }
  ]
}

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.

Response

The current order settings.

orderSettings

object

required

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

Show child attributes

OVERVIEW

ACCOUNT

CATALOG

ANALYTICS

DASHBOARDS

COSTS

PRODUCTS

EVENTS

Get order settings

Authorizations

Response