Skip to main content
POST
Check current pickup, merchant coverage and carrier availability

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Body

application/json
pickup
object
required

Use either a saved pickup code or a coordinate pin.

destination
object
required
pickupWindow
object

Response

Current serviceability decision

serviceable
boolean
required
evaluatedAt
string<date-time>
required
unavailableReasonCode
enum<string> | null
Available options:
PICKUP_UNAVAILABLE,
PICKUP_OUTSIDE_OPERATING_HOURS,
OUTSIDE_MERCHANT_COVERAGE,
NO_PROVIDER_AVAILABLE,
null
coverageZoneVersionId
string<uuid> | null