Dispatch auto-mapping job
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"apply_purgatory_settings": false
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map"
payload = { "apply_purgatory_settings": False }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({apply_purgatory_settings: false})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map', 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/jobs/auto-map",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'apply_purgatory_settings' => false
]),
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/jobs/auto-map"
payload := strings.NewReader("{\n \"apply_purgatory_settings\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"apply_purgatory_settings\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apply_purgatory_settings\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"job_id": 123,
"apply_purgatory_settings": true
}{
"message": "<string>"
}Purgatory
Dispatch auto-mapping job
Dispatches the OrderAutoMappingJob to attempt to map line items in every
non-posted order using existing SKU and alternate-SKU rules. Equivalent to
the admin “Auto Map SKUs and Reprocess Orders” button.
When apply_purgatory_settings=true, the job also re-runs purgatory rules
after mapping completes, so cleanly-mapped orders can post automatically.
Returns immediately — the actual work happens in the queue. Poll the order list or individual orders to see the results.
POST
/
purgatory
/
jobs
/
auto-map
Dispatch auto-mapping job
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"apply_purgatory_settings": false
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map"
payload = { "apply_purgatory_settings": False }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({apply_purgatory_settings: false})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map', 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/jobs/auto-map",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'apply_purgatory_settings' => false
]),
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/jobs/auto-map"
payload := strings.NewReader("{\n \"apply_purgatory_settings\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"apply_purgatory_settings\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/purgatory/jobs/auto-map")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apply_purgatory_settings\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"job_id": 123,
"apply_purgatory_settings": true
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Body
application/json
When true, re-run purgatory rules after auto-mapping completes.
Equivalent to chaining auto-map and reprocess in one call.