Get purgatory automation settings
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/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{
"data": {
"post_empty_orders": true,
"post_orders_ignored_all_items": true,
"post_clean_orders": true,
"ignore_empty_sku": true,
"ignore_adjustment_line_item": true,
"skip_inventory_for_old_shipments": true,
"skip_inventory_for_old_shipments_days": 1,
"skip_inventory_for_similar_orders": true,
"similarity_threshold": 0.5,
"skip_orders_older_than_date_cutoff": "2023-11-07T05:31:56Z",
"skip_orders_older_than_date_cutoff_by_account": [
{
"app_integration_account_id": 2,
"cutoff": "2023-11-07T05:31:56Z"
}
],
"ignored_skus": [
"<string>"
],
"ignored_product_names": [
"<string>"
],
"ignored_patterns": [
"<string>"
],
"push_client_invoice_to_shipstation": true,
"push_client_invoice_shipstation_store_id": 123,
"push_client_invoice_to_shipstation_automatically": true,
"push_client_invoice_to_shipstation_timing": "<string>"
},
"schema_url": "<string>"
}{
"message": "<string>"
}Purgatory
Get purgatory automation settings
Returns all purgatory automation settings for the tenant, keyed by their
external (snake_case) names. Includes a schema_url pointing at
GET /purgatory/settings/schema for field-level documentation.
Fields missing from stored configuration fall back to the default declared in the schema.
GET
/
purgatory
/
settings
Get purgatory automation settings
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/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{
"data": {
"post_empty_orders": true,
"post_orders_ignored_all_items": true,
"post_clean_orders": true,
"ignore_empty_sku": true,
"ignore_adjustment_line_item": true,
"skip_inventory_for_old_shipments": true,
"skip_inventory_for_old_shipments_days": 1,
"skip_inventory_for_similar_orders": true,
"similarity_threshold": 0.5,
"skip_orders_older_than_date_cutoff": "2023-11-07T05:31:56Z",
"skip_orders_older_than_date_cutoff_by_account": [
{
"app_integration_account_id": 2,
"cutoff": "2023-11-07T05:31:56Z"
}
],
"ignored_skus": [
"<string>"
],
"ignored_product_names": [
"<string>"
],
"ignored_patterns": [
"<string>"
],
"push_client_invoice_to_shipstation": true,
"push_client_invoice_shipstation_store_id": 123,
"push_client_invoice_to_shipstation_automatically": true,
"push_client_invoice_to_shipstation_timing": "<string>"
},
"schema_url": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Response
Current settings
⌘I