Get Retailers
curl --request GET \
--url https://api.example.com/retailersimport requests
url = "https://api.example.com/retailers"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/retailers', 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.example.com/retailers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/retailers"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/retailers")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/retailers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"retailers": []
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Retailers
Get Retailers
Get configured retailers
GET
/
retailers
Get Retailers
curl --request GET \
--url https://api.example.com/retailersimport requests
url = "https://api.example.com/retailers"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/retailers', 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.example.com/retailers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/retailers"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/retailers")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/retailers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"retailers": []
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Partner app access
Partner apps can call this endpoint on behalf of the authorizing brand with an OAuth access token containingretailers:read. No API key is required.
curl 'https://api.subtotal.com/retailers?include=all' \
--header "Authorization: Bearer $SUBTOTAL_ACCESS_TOKEN"
include=enabled(default) returns retailers configured for the authorizing brand.include=allreturns all active retailers. Each retailer’senabledandlink_urlvalues reflect only that brand’s configuration; disabled retailers have a nulllink_url.
retailers:read receives 403 insufficient_scope. For older installations, follow the reauthorization steps.
Retailer
link_url values are static URLs that are deprecated and will be removed in a future release. Use customer Link tokens instead. Existing URLs continue to work for now.Query Parameters
enabled (default) — only the retailers enabled for the client; all — every active retailer.
Available options:
enabled, all Response
Successful Response
Show child attributes
Show child attributes