Get customer document requirements and shipper rules
curl --request GET \
--url https://api.upwell.com/api/rest/customers/{id}/requirements \
--header 'Authorization: <api-key>'import requests
url = "https://api.upwell.com/api/rest/customers/{id}/requirements"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.upwell.com/api/rest/customers/{id}/requirements', 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.upwell.com/api/rest/customers/{id}/requirements",
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: <api-key>"
],
]);
$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.upwell.com/api/rest/customers/{id}/requirements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.upwell.com/api/rest/customers/{id}/requirements")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/customers/{id}/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"customerRequirements": {
"customerId": "cus_example",
"documentRequirements": {
"receivable": [
{
"exceptionType": "CUSTOMER_INVOICE_MISSING_BOL",
"documentTypes": [
"BILL_OF_LADING"
],
"enabled": false,
"status": "not_required",
"source": "customer",
"ruleId": "rul_waiver",
"overrideRuleId": "rul_waiver",
"configuration": null,
"applicability": "BOL; configuration may exempt TONU/TORD loads or allow a signed POD (customer override only). Prepaid invoices and invoices delivered outside Upwell are exempt."
}
],
"carrier": []
},
"shipperRules": [
{
"id": "rul_shipper",
"name": "Signed paperwork",
"description": "Supply signed paperwork",
"enabled": true,
"source": "global",
"overrideRuleId": null,
"condition": "ALWAYS"
}
]
}
}{
"error": "Authentication hook unauthorized this request",
"path": "$",
"code": "access-denied"
}Customers
Get customer document requirements and shipper rules
Read the customer’s effective Required Documents and Shipper Rules settings, combining organization defaults and customer overrides. Uses the existing API key and customer/rule read permissions. See Customer requirements for inheritance, conditional checks, examples, and error handling. This is a settings read, not an invoice missing-documents verdict. Missing, archived, and inaccessible customers return HTTP 200 with customerRequirements: null. Hasura may return HTTP 200 with an errors body when the remote resolver fails; check for errors and a non-null result. Unauthorized roles are rejected.
GET
/
api
/
rest
/
customers
/
{id}
/
requirements
Get customer document requirements and shipper rules
curl --request GET \
--url https://api.upwell.com/api/rest/customers/{id}/requirements \
--header 'Authorization: <api-key>'import requests
url = "https://api.upwell.com/api/rest/customers/{id}/requirements"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.upwell.com/api/rest/customers/{id}/requirements', 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.upwell.com/api/rest/customers/{id}/requirements",
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: <api-key>"
],
]);
$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.upwell.com/api/rest/customers/{id}/requirements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.upwell.com/api/rest/customers/{id}/requirements")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/customers/{id}/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"customerRequirements": {
"customerId": "cus_example",
"documentRequirements": {
"receivable": [
{
"exceptionType": "CUSTOMER_INVOICE_MISSING_BOL",
"documentTypes": [
"BILL_OF_LADING"
],
"enabled": false,
"status": "not_required",
"source": "customer",
"ruleId": "rul_waiver",
"overrideRuleId": "rul_waiver",
"configuration": null,
"applicability": "BOL; configuration may exempt TONU/TORD loads or allow a signed POD (customer override only). Prepaid invoices and invoices delivered outside Upwell are exempt."
}
],
"carrier": []
},
"shipperRules": [
{
"id": "rul_shipper",
"name": "Signed paperwork",
"description": "Supply signed paperwork",
"enabled": true,
"source": "global",
"overrideRuleId": null,
"condition": "ALWAYS"
}
]
}
}{
"error": "Authentication hook unauthorized this request",
"path": "$",
"code": "access-denied"
}Read the Customer requirements guide before interpreting conditional checks or customer waivers.

