logo
get

/vehicle-transfer-orders/{id}

Retrieve specified Vehicle Transfer Order.

Authorization

apiKey - Authorization

Request Parameters

1 Path Parameter

Responses

OK

Schema
object

A Vehicle Transfer Order.

id
string
1 validation + required
referenceNumber
string
1 validation + required
created
object
required
vehicle
object

When creating an order, there are 2 options for providing the Vehicle information. See here

required
directions
object
required
fare
object
required
geolocation
object
notes
string
1 validation
orderId
string
1 validation + required
payer
object
reconciliationCode
string
1 validation
states
object
status
string

See the Vehicle Transfer Order Statuses guide for detailed information.

1 validation + required
timeline
array[object]
transporter
object
dedicatedTransporter
object
canceled
object
errors
array[object]
labels
array[object]
canCancel
boolean
inspections
array[object]
preferredTransporters
array[object]

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
1 variable not set
Authorization