Check postal code
Check whether a location can deliver to a country and postal code, without a full address. Use it where you only have a postal code, such as a checkout before the address is entered, or a coverage lookup.
Treat it as a pre-check: a cheap filter that rules a postal code in or out before an address exists. A deliverable: true here means the postal code area is served, not that a specific address in it is. POST /orders/check/{locationId} stays the source of truth for an exact answer.
Authorizations
Path Parameters
The location whose coverage you want to check. The same identifier you pass to the check endpoint.
Body
Postal code to check. Case and whitespace are ignored, so 1018 PN, 1018pn and 1018PN are treated as the same code.
"1018PN"
ISO 3166-1 alpha-2 country code the postal code belongs to.
"NL"
Collo dimensions in mm. Must satisfy length >= width >= height.
Weight in grams.
1500
Delivery requires a signature.
false
Do not deliver to a neighbour.
false
Response
Validation result
Whether the postal code area can be served for this location.
true
Why the postal code is not deliverable. Only present when deliverable is false.
"OUT_OF_AREA"
Requested capabilities no carrier could satisfy. Only present when deliverable is false.