Validate a route and evaluate courier rules
POST /api/v5/locations/validate-route
Validates an origin/destination/items route and returns, per courier, the rules that apply and whether the courier can quote the route. Requires an API key.
Request Body
Section titled “Request Body ”object
Origin (pickup) location for the route.
object
4-digit AU postcode of the location.
Suburb/locality of the location.
State code (e.g. NSW, VIC).
2-letter ISO country code; defaults to AU.
Address type, “business” or “residential”; defaults to business.
Explicit residential flag, overriding type when set.
Destination (delivery) location for the route.
object
4-digit AU postcode of the location.
Suburb/locality of the location.
State code (e.g. NSW, VIC).
2-letter ISO country code; defaults to AU.
Address type, “business” or “residential”; defaults to business.
Explicit residential flag, overriding type when set.
Items to be shipped along the route.
object
Package type/contents description; defaults to “Carton”.
Packaging type override for the item.
Item weight in kg.
Item length in cm.
Item width in cm.
Item height in cm.
Number of identical items; defaults to 1.
Courier string_ids to restrict validation to; null/omit for all.
Responses
Section titled “ Responses ”Per-courier validation result
object
Per-courier validation results, keyed by courier string_id.
object
object
Rules that apply to this courier for the route.
object
Machine-readable rule code.
Rule severity: “block” (cannot quote), “surcharge” (adds cost), or “prompt” (warn user).
Human-readable explanation of the rule.
Surcharge added when severity is “surcharge”, in AUD.
Additional structured metadata about the rule.
object
Arbitrary JSON value (string, number, boolean, null, array, or object).
Whether the courier can quote the route (no blocking rules).
Missing or invalid API key