curl --request GET \
--url https://api.exowpee.com/v1/team/companies/{company}/settings/{settings} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/team/companies/{company}/settings/{settings}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/team/companies/{company}/settings/{settings}', 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.exowpee.com/v1/team/companies/{company}/settings/{settings}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.exowpee.com/v1/team/companies/{company}/settings/{settings}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.exowpee.com/v1/team/companies/{company}/settings/{settings}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/team/companies/{company}/settings/{settings}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"company_id": "<string>",
"order_currency_exponent": 123,
"order_currency_code": "<string>",
"timezone": "<string>",
"manual_discount_approval_threshold": "<string>",
"allow_manual_with_campaign": true,
"orders_count": 123,
"currency_round": 123,
"default_tax_value": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}View company settings
Shows a company’s settings such as timezone, rounding, default tax and manual discount rules.
curl --request GET \
--url https://api.exowpee.com/v1/team/companies/{company}/settings/{settings} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/team/companies/{company}/settings/{settings}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/team/companies/{company}/settings/{settings}', 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.exowpee.com/v1/team/companies/{company}/settings/{settings}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.exowpee.com/v1/team/companies/{company}/settings/{settings}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.exowpee.com/v1/team/companies/{company}/settings/{settings}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/team/companies/{company}/settings/{settings}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"company_id": "<string>",
"order_currency_exponent": 123,
"order_currency_code": "<string>",
"timezone": "<string>",
"manual_discount_approval_threshold": "<string>",
"allow_manual_with_campaign": true,
"orders_count": 123,
"currency_round": 123,
"default_tax_value": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}settings.retrieve
Conditions
- Agent accounts are refused.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the company (27-character KSUID string). It must be the company selected in the session.
Identifier of the settings record (27-character KSUID string). It must belong to that company; each company has exactly one.
Query Parameters
Response mode. Default resource; none answers 204 No Content.
resource Comma-separated JSON keys of the root resource (id is always rendered). Available: id, company_id, order_currency_exponent, order_currency_code, timezone, manual_discount_approval_threshold, allow_manual_with_campaign, orders_count, currency_round, default_tax_value, created_at, updated_at.
Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .
Response
Resource.
Identifier of the settings record (27-character KSUID string).
Identifier of the company the record belongs to.
Number of decimal places of the order currency (0 for XOF); an amount in minor units divided by 10 to this power gives the amount in the currency. Set when the company is created.
3-character code of the currency in which the company's orders are expressed, set when the company is created.
Time zone identifier of the company (for example Africa/Porto-Novo, the default for new companies). Working-hours checks use it.
Percentage (0 to 100, up to 6 decimals) above which a sale is routed to approval: one manual discount above this share of its calculation base, or all manual discounts together above this share of the order amount before discounts and tax; null means never. Returned as a decimal string.
Whether a manual discount may be combined with discount campaigns. When false, campaigns are skipped on a sale that has a manual discount; defaults to true.
Maximum number of orders the company may process per month; null means no limit and 0 blocks order processing. Not editable through the settings update; new companies start at 0.
Rounding setting of the company, a non-negative integer; 0 by default for new companies. Also returned with the session company settings.
Default tax rate of the company as a whole-number percentage from 0 to 100; 18 by default for new companies.
Date and time the record was created (ISO 8601, UTC).
Date and time the record was last changed (ISO 8601, UTC).