GET /v1/vehicle-types
GET /v1/vehicle-types
| Scope | Idempotency-Key | Operation ID |
|---|---|---|
geography.read | — | listVehicleTypes |
Vehicle types for a delivery between two suburbs.
The one catalogue, in its order, with each type's plain-language purpose. Types the
tenant's configuration does not allow are left out. Each remaining type is
available only if it is not withdrawn from either end's zone and an eligible delivery
partner offers it between these areas; an unavailable type is listed with
unavailable_reason (AREA_RESTRICTED or NO_CARRIER) and the sentence surfaces show,
and must not be selectable. An area outside the tenant's allowed gateways or
zones is LOCATION_NOT_SUPPORTED.
Request
Signed with your API credential: see Authentication.
| Parameter | In | Required | Description |
|---|---|---|---|
pickup | query | Yes | Pattern ^SUB-[0-9A-HJKMNP-TV-Z]{8}$. |
dropoff | query | Yes | Pattern ^SUB-[0-9A-HJKMNP-TV-Z]{8}$. |
Responses
200
The catalogue for this delivery.
| Field | Type | Required | Description |
|---|---|---|---|
items | array of object | Yes | |
items[].code | string | Yes | |
items[].name | string | Yes | |
items[].intended_load | string | Yes | |
items[].constraints | string | Yes | |
items[].available | boolean | Yes | |
items[].unavailable_reason | string or null | Yes | One of: AREA_RESTRICTED, NO_CARRIER. |
items[].unavailable_message | string or null | Yes |
400
Structural validation failed or an Idempotency-Key is missing.
The error envelope: code, message, detail, request_id.
401
Unknown, revoked or wrong-environment credential, bad signature, or expired session.
The error envelope: code, message, detail, request_id.
403
Tenant access denied (existence is not disclosed), insufficient scope, MFA/step-up required, partner blocked or module disabled.
The error envelope: code, message, detail, request_id.
404
No such route, or no such resource visible to the caller.
The error envelope: code, message, detail, request_id.
422
Semantically invalid (location, vehicle, server-controlled field, bulk limits).
The error envelope: code, message, detail, request_id.
429
Rate limit reached; honour Retry-After.
The error envelope: code, message, detail, request_id.
500
Unexpected failure. Only code and request_id are returned.
The error envelope: code, message, detail, request_id.
503
Pricing/routing unavailable, request timeout, retryable contention, or an operator must act first (ACCOUNTING_PERIOD_UNAVAILABLE, outcome REQUIRES_ADMIN), or the payment provider cannot start a payment (PAYMENT_PROVIDER_UNAVAILABLE, outcome REQUIRES_PAYMENT; nothing charged).
The error envelope: code, message, detail, request_id.