Partially update purgatory settings

curl --request PUT \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --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>"
}
'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings"

payload = {
    "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>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
  })
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings"

	payload := strings.NewReader("{\n  \"post_empty_orders\": true,\n  \"post_orders_ignored_all_items\": true,\n  \"post_clean_orders\": true,\n  \"ignore_empty_sku\": true,\n  \"ignore_adjustment_line_item\": true,\n  \"skip_inventory_for_old_shipments\": true,\n  \"skip_inventory_for_old_shipments_days\": 1,\n  \"skip_inventory_for_similar_orders\": true,\n  \"similarity_threshold\": 0.5,\n  \"skip_orders_older_than_date_cutoff\": \"2023-11-07T05:31:56Z\",\n  \"skip_orders_older_than_date_cutoff_by_account\": [\n    {\n      \"app_integration_account_id\": 2,\n      \"cutoff\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"ignored_skus\": [\n    \"<string>\"\n  ],\n  \"ignored_product_names\": [\n    \"<string>\"\n  ],\n  \"ignored_patterns\": [\n    \"<string>\"\n  ],\n  \"push_client_invoice_to_shipstation\": true,\n  \"push_client_invoice_shipstation_store_id\": 123,\n  \"push_client_invoice_to_shipstation_automatically\": true,\n  \"push_client_invoice_to_shipstation_timing\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"post_empty_orders\": true,\n  \"post_orders_ignored_all_items\": true,\n  \"post_clean_orders\": true,\n  \"ignore_empty_sku\": true,\n  \"ignore_adjustment_line_item\": true,\n  \"skip_inventory_for_old_shipments\": true,\n  \"skip_inventory_for_old_shipments_days\": 1,\n  \"skip_inventory_for_similar_orders\": true,\n  \"similarity_threshold\": 0.5,\n  \"skip_orders_older_than_date_cutoff\": \"2023-11-07T05:31:56Z\",\n  \"skip_orders_older_than_date_cutoff_by_account\": [\n    {\n      \"app_integration_account_id\": 2,\n      \"cutoff\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"ignored_skus\": [\n    \"<string>\"\n  ],\n  \"ignored_product_names\": [\n    \"<string>\"\n  ],\n  \"ignored_patterns\": [\n    \"<string>\"\n  ],\n  \"push_client_invoice_to_shipstation\": true,\n  \"push_client_invoice_shipstation_store_id\": 123,\n  \"push_client_invoice_to_shipstation_automatically\": true,\n  \"push_client_invoice_to_shipstation_timing\": \"<string>\"\n}")
  .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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"post_empty_orders\": true,\n  \"post_orders_ignored_all_items\": true,\n  \"post_clean_orders\": true,\n  \"ignore_empty_sku\": true,\n  \"ignore_adjustment_line_item\": true,\n  \"skip_inventory_for_old_shipments\": true,\n  \"skip_inventory_for_old_shipments_days\": 1,\n  \"skip_inventory_for_similar_orders\": true,\n  \"similarity_threshold\": 0.5,\n  \"skip_orders_older_than_date_cutoff\": \"2023-11-07T05:31:56Z\",\n  \"skip_orders_older_than_date_cutoff_by_account\": [\n    {\n      \"app_integration_account_id\": 2,\n      \"cutoff\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"ignored_skus\": [\n    \"<string>\"\n  ],\n  \"ignored_product_names\": [\n    \"<string>\"\n  ],\n  \"ignored_patterns\": [\n    \"<string>\"\n  ],\n  \"push_client_invoice_to_shipstation\": true,\n  \"push_client_invoice_shipstation_store_id\": 123,\n  \"push_client_invoice_to_shipstation_automatically\": true,\n  \"push_client_invoice_to_shipstation_timing\": \"<string>\"\n}"

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>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

PUT

purgatory

settings

Partially update purgatory settings

curl --request PUT \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --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>"
}
'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings"

payload = {
    "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>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
  })
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings"

	payload := strings.NewReader("{\n  \"post_empty_orders\": true,\n  \"post_orders_ignored_all_items\": true,\n  \"post_clean_orders\": true,\n  \"ignore_empty_sku\": true,\n  \"ignore_adjustment_line_item\": true,\n  \"skip_inventory_for_old_shipments\": true,\n  \"skip_inventory_for_old_shipments_days\": 1,\n  \"skip_inventory_for_similar_orders\": true,\n  \"similarity_threshold\": 0.5,\n  \"skip_orders_older_than_date_cutoff\": \"2023-11-07T05:31:56Z\",\n  \"skip_orders_older_than_date_cutoff_by_account\": [\n    {\n      \"app_integration_account_id\": 2,\n      \"cutoff\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"ignored_skus\": [\n    \"<string>\"\n  ],\n  \"ignored_product_names\": [\n    \"<string>\"\n  ],\n  \"ignored_patterns\": [\n    \"<string>\"\n  ],\n  \"push_client_invoice_to_shipstation\": true,\n  \"push_client_invoice_shipstation_store_id\": 123,\n  \"push_client_invoice_to_shipstation_automatically\": true,\n  \"push_client_invoice_to_shipstation_timing\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://{companyName}.api.joinluminous.com/external/api/v1/purgatory/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"post_empty_orders\": true,\n  \"post_orders_ignored_all_items\": true,\n  \"post_clean_orders\": true,\n  \"ignore_empty_sku\": true,\n  \"ignore_adjustment_line_item\": true,\n  \"skip_inventory_for_old_shipments\": true,\n  \"skip_inventory_for_old_shipments_days\": 1,\n  \"skip_inventory_for_similar_orders\": true,\n  \"similarity_threshold\": 0.5,\n  \"skip_orders_older_than_date_cutoff\": \"2023-11-07T05:31:56Z\",\n  \"skip_orders_older_than_date_cutoff_by_account\": [\n    {\n      \"app_integration_account_id\": 2,\n      \"cutoff\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"ignored_skus\": [\n    \"<string>\"\n  ],\n  \"ignored_product_names\": [\n    \"<string>\"\n  ],\n  \"ignored_patterns\": [\n    \"<string>\"\n  ],\n  \"push_client_invoice_to_shipstation\": true,\n  \"push_client_invoice_shipstation_store_id\": 123,\n  \"push_client_invoice_to_shipstation_automatically\": true,\n  \"push_client_invoice_to_shipstation_timing\": \"<string>\"\n}")
  .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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"post_empty_orders\": true,\n  \"post_orders_ignored_all_items\": true,\n  \"post_clean_orders\": true,\n  \"ignore_empty_sku\": true,\n  \"ignore_adjustment_line_item\": true,\n  \"skip_inventory_for_old_shipments\": true,\n  \"skip_inventory_for_old_shipments_days\": 1,\n  \"skip_inventory_for_similar_orders\": true,\n  \"similarity_threshold\": 0.5,\n  \"skip_orders_older_than_date_cutoff\": \"2023-11-07T05:31:56Z\",\n  \"skip_orders_older_than_date_cutoff_by_account\": [\n    {\n      \"app_integration_account_id\": 2,\n      \"cutoff\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"ignored_skus\": [\n    \"<string>\"\n  ],\n  \"ignored_product_names\": [\n    \"<string>\"\n  ],\n  \"ignored_patterns\": [\n    \"<string>\"\n  ],\n  \"push_client_invoice_to_shipstation\": true,\n  \"push_client_invoice_shipstation_store_id\": 123,\n  \"push_client_invoice_to_shipstation_automatically\": true,\n  \"push_client_invoice_to_shipstation_timing\": \"<string>\"\n}"

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>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json

Purgatory automation settings. All fields are optional in write payloads — only keys present in the body are updated. See GET /purgatory/settings/schema for field-level types, defaults, and descriptions.

post_empty_orders

boolean

Auto-post sales orders that have no line items.

post_orders_ignored_all_items

boolean

Auto-post orders whose every line item is ignored.

post_clean_orders

boolean

Auto-post orders whose remaining non-ignored lines are all mapped to a product. Affects inventory — orders posted this way decrement stock.

ignore_empty_sku

boolean

Treat line items with an empty SKU as ignored.

ignore_adjustment_line_item

boolean

Treat adjustment lines (coupons, negative qty, etc.) as ignored.

skip_inventory_for_old_shipments

boolean

Do not deduct inventory for shipments older than the threshold.

skip_inventory_for_old_shipments_days

integer

Age in days at which a shipment is considered "old" for the skip rule.

Required range: x >= 0

skip_inventory_for_similar_orders

boolean

Skip inventory for shipments that look like duplicates of recently-posted orders.

similarity_threshold

number<float> | null

Score (0–1) above which two orders are considered duplicates. Required when skip_inventory_for_similar_orders is true.

Required range: 0 <= x <= 1

skip_orders_older_than_date_cutoff

string<date-time> | null

Orders with order_date before this ISO 8601 datetime are skipped by purgatory automation. null disables the cutoff.

skip_orders_older_than_date_cutoff_by_account

object[]

Per-app-integration-account order_date cutoffs. A matching account row overrides the global skip_orders_older_than_date_cutoff for that account; accounts without a row fall back to the global cutoff.

Show child attributes

ignored_skus

string[]

SKUs to always treat as ignored (exact match, case-insensitive).

ignored_product_names

string[]

Product names to always treat as ignored (exact match, case-insensitive).

ignored_patterns

string[]

Substrings or PHP regex patterns (wrap regex in slashes, e.g. /^test/) matched against the line item SKU or name.

push_client_invoice_to_shipstation

boolean

Push generated client invoices back to ShipStation as posted orders.

push_client_invoice_shipstation_store_id

integer | null

ShipStation store ID that receives pushed client invoices.

push_client_invoice_to_shipstation_automatically

boolean

Push client invoices automatically rather than waiting for a manual trigger.

push_client_invoice_to_shipstation_timing

string | null

When the automatic push fires (e.g. on_invoice_create, on_invoice_send).

Response

Merged settings after update

data

object

Show child attributes

schema_url

string

message

string

Get purgatory automation settings Get purgatory settings schema

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Partially update purgatory settings

Authorizations

Body

Response