Skip to main content
POST
Check order

Authorizations

api-key
string
header
required

Path Parameters

locationId
string
required

Body

application/json
deliveryAddress
object
required
dimensions
object

Collo dimensions in mm. Must satisfy length >= width >= height.

weight
number

Weight in grams.

Example:

1500

signature
boolean

Delivery requires a signature.

Example:

false

notAtNeighbour
boolean

Do not deliver to a neighbour.

Example:

false

Response

Validation result

deliverable
boolean
required

Whether the address can be served for this location.

Example:

true

resolvedAddress
object
required

The geocoded address the delivery check was performed with. Geocoding may correct the submitted address, so inspect this to confirm what was actually used.

reason
string

Why the address is not deliverable. Only present when deliverable is false.

Example:

"OUT_OF_AREA"

missingCapabilities
object

Requested capabilities no carrier could satisfy. Only present when deliverable is false.