Get the shipping-rule schema
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/shipping-rules/schema \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/shipping-rules/schema"
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/shipping-rules/schema', 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/shipping-rules/schema",
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/shipping-rules/schema"
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/shipping-rules/schema")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/shipping-rules/schema")
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": {
"description": "An ordered list of shipping rules. Every rule whose conditions all hold applies, top to bottom …",
"maxRules": 100,
"rule": {
"name": {
"type": "string",
"required": true,
"description": "Unique, shown in label refusals and rate badges."
},
"when": {
"packingClasses": {
"type": "string[]",
"options": [
"ambient",
"perishable_dry_ice",
"flour",
"fragile",
"bulk",
"liquid"
],
"description": "Any line on the order has one of these packing classes."
}
},
"then": {
"shipDays": {
"type": "string[]",
"options": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"description": "Labels may only be bought on these days (tenant operating timezone)."
}
}
}
}
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"message": "User does not have the right permissions."
}Shipping Rules
Get the shipping-rule schema
Describe the shipping-rule format — every condition (when) and effect (then), with its type,
allowed options and meaning — plus the maximum number of rules. Useful for building an editor
or for an AI agent authoring rules.
Available to every account. When per-user permissions are enabled, the token’s owner needs the fulfillmentSettings.read permission (the same as the Operations Admin pages); otherwise 403.
GET
/
shipping-rules
/
schema
Get the shipping-rule schema
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/shipping-rules/schema \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/shipping-rules/schema"
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/shipping-rules/schema', 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/shipping-rules/schema",
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/shipping-rules/schema"
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/shipping-rules/schema")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/shipping-rules/schema")
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": {
"description": "An ordered list of shipping rules. Every rule whose conditions all hold applies, top to bottom …",
"maxRules": 100,
"rule": {
"name": {
"type": "string",
"required": true,
"description": "Unique, shown in label refusals and rate badges."
},
"when": {
"packingClasses": {
"type": "string[]",
"options": [
"ambient",
"perishable_dry_ice",
"flour",
"fragile",
"bulk",
"liquid"
],
"description": "Any line on the order has one of these packing classes."
}
},
"then": {
"shipDays": {
"type": "string[]",
"options": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"description": "Labels may only be bought on these days (tenant operating timezone)."
}
}
}
}
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"message": "User does not have the right permissions."
}