RunBuggy Vehicle Transfer Orders API
The Vehicle Transfer Order operations.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/runbuggy-vehicle-transfer-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Vehicle Transfer Orders API
description: '### [Create Orders](/docs/shipping/6fcc8c040ec03-create-an-order) to transfer vehicles.'
termsOfService: https://runbuggy.com/terms/
contact:
name: Support
email: support@runbuggy.com
license:
name: Copyright © RunBuggy 2023
url: https://runbuggy.com/terms/
version: '1.0'
servers:
- url: https://ng-staging.runbuggy.com/staging/api
tags:
- name: Vehicle Transfer Orders
description: The Vehicle Transfer Order operations.
paths:
/vehicle-transfer-orders:
get:
tags:
- Vehicle Transfer Orders
summary: Find vehicle transfer orders
description: Retrieve a paginated Vehicle Transfer Orders.
operationId: findVehicleTransferOrdersPaginatedUsingGET
parameters:
- name: size
in: query
required: false
schema:
type: integer
format: int32
- name: page
in: query
required: false
schema:
type: integer
format: int32
- name: limit
in: query
required: false
schema:
type: integer
format: int32
- name: sort
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PageVehicleTransferOrder'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
deprecated: false
security:
- Authorization: []
servers:
- url: https://ng-staging.runbuggy.com/staging/api
/vehicle-transfer-orders/{id}:
get:
tags:
- Vehicle Transfer Orders
summary: Retrieve a vehicle transfer order
description: Retrieve specified Vehicle Transfer Order.
operationId: getVehicleTransferOrderUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleTransferOrder'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
deprecated: false
security:
- Authorization: []
servers:
- url: https://ng-staging.runbuggy.com/staging/api
patch:
tags:
- Vehicle Transfer Orders
summary: Update a vehicle transfer order
description: Update specified Vehicle Transfer Order.
operationId: updateVehicleTransferOrderUsingPATCH
parameters:
- name: id
in: path
description: id
required: true
schema:
type: string
responses:
'202':
description: Accepted
content:
'*/*':
schema:
$ref: '#/components/schemas/VehicleTransferOrder'
'400':
description: Forbidden
'401':
description: ''
'403':
description: ''
deprecated: false
security:
- Authorization: []
servers:
- url: https://ng-staging.runbuggy.com/staging/api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleTransferOrderPatch'
description: VehicleTransferOrder
required: true
/vehicle-transfer-orders/{id}/expanded:
get:
tags:
- Vehicle Transfer Orders
summary: Get expanded vehicle transfer order
operationId: getExpandedUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleTransferOrderExpanded'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
deprecated: false
security:
- Authorization: []
servers:
- url: https://ng-staging.runbuggy.com/staging/api
/vehicle-transfer-orders/expanded:
get:
tags:
- Vehicle Transfer Orders
summary: Find vehicle transfer orders expanded
description: Retrieve paginated expanded Vehicle Transfer Orders.
operationId: findVehicleTransferOrdersExpandedPaginatedUsingGET
parameters:
- name: size
in: query
required: false
schema:
type: integer
format: int32
- name: page
in: query
required: false
schema:
type: integer
format: int32
- name: limit
in: query
required: false
schema:
type: integer
format: int32
- name: sort
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PageVehicleTransferOrderExpanded'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
deprecated: false
security:
- Authorization: []
servers:
- url: https://ng-staging.runbuggy.com/staging/api
/vehicle-transfer-orders/gate-passes:
post:
tags:
- Vehicle Transfer Orders
summary: Create a gate pass
operationId: createGatePassUsingPOST
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TempFile'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
deprecated: false
security:
- Authorization: []
servers:
- url: https://ng-staging.runbuggy.com/staging/api
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
description: file
/vehicle-transfer-orders/{id}/gate-passes:
get:
tags:
- Vehicle Transfer Orders
summary: Get gate passes
operationId: getGatePassesUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Attachment'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
deprecated: false
security:
- Authorization: []
servers:
- url: https://ng-staging.runbuggy.com/staging/api
post:
tags:
- Vehicle Transfer Orders
summary: Add a gate pass
operationId: addGatePassUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: string
responses:
'200':
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
deprecated: false
security:
- Authorization: []
servers:
- url: https://ng-staging.runbuggy.com/staging/api
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
description: file
/vehicle-transfer-orders/{id}/gate-passes/{passId}:
get:
tags:
- Vehicle Transfer Orders
summary: Retrieve a gate pass
operationId: getGatePassUsingGET
parameters:
- name: passId
in: path
description: passId
required: true
schema:
type: string
- name: id
in: path
description: id
required: true
schema:
type: string
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
deprecated: false
security:
- Authorization: []
servers:
- url: https://ng-staging.runbuggy.com/staging/api
components:
schemas:
FareItem:
type: object
title: FareItem
description: Order Fare Item
properties:
name:
type: string
description:
type: string
value:
type: number
format: double
Replacement:
type: object
title: Replacement
properties:
created:
$ref: '#/components/schemas/Created'
message:
type: string
orderId:
type: string
status:
type: string
enum:
- PENDING
- SUCCESS
- ERROR
VehicleMeasurements:
type: object
title: VehicleMeasurements
properties:
curbWeight:
type: number
format: double
grossVehicleWeightRating:
type: number
format: double
height:
type: number
format: double
length:
type: number
format: double
width:
type: number
format: double
Canceled:
type: object
title: Canceled
properties:
byUser:
type: string
date:
type: string
description: Datetime in ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
reason:
type: string
VehicleTransferOrderPatch:
type: object
title: VehicleTransferOrderPatch
properties:
directions:
$ref: '#/components/schemas/DirectionsPatch'
gatePasses:
type: array
items:
$ref: '#/components/schemas/TempFile'
labels:
type: object
additionalProperties:
type: string
notes:
type: string
vehicle:
$ref: '#/components/schemas/VehiclePatch'
Company:
type: object
title: Company
properties:
id:
type: string
x-examples:
- c0ef80ce-2579-4682-af4f-c1d29457848a
name:
type: string
x-examples:
- Auto Land
type:
type: string
enum:
- DEALER
- AUCTION
x-examples:
- DEALER
InspectionSummary:
type: object
title: InspectionSummary
properties:
completed:
$ref: '#/components/schemas/Created'
created:
$ref: '#/components/schemas/Created'
id:
type: string
taskName:
type: string
DirectionsPatch:
type: object
title: DirectionsPatch
properties:
dropoff:
$ref: '#/components/schemas/LocationPatch'
pickup:
$ref: '#/components/schemas/LocationPatch'
EstimatedTimeToArrival:
type: object
title: EstimatedTimeToArrival
properties:
start:
type: string
description: Start of ETA window of time. ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
end:
type: string
description: End of ETA window of time. Datetime in ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
initial:
type: string
description: Datetime in ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
accuracy:
type: string
calculated:
type: string
format: date-time
status:
type: string
Item:
type: object
title: Item
properties:
amount:
type: number
format: double
name:
type: string
Attachment:
type: object
title: Attachment
properties:
created:
$ref: '#/components/schemas/Created'
description:
type: string
id:
type: string
name:
type: string
resourcePath:
type: string
Event:
type: object
title: Event
properties:
dateTime:
type: string
description: Datetime in ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
name:
type: string
Contact:
type: object
title: Contact
properties:
name:
type: string
x-examples:
- Ed Jones
phone:
type: string
x-examples:
- '4804804480'
VehicleTransferOrder:
type: object
title: VehicleTransferOrder
description: A Vehicle Transfer Order.
properties:
id:
type: string
x-examples:
- 7a765a49-6b21-4368-937e-8ce4981d8eff
referenceNumber:
type: string
x-examples:
- 2000232-123432
created:
$ref: '#/components/schemas/Created'
vehicle:
$ref: '#/components/schemas/Vehicle'
directions:
$ref: '#/components/schemas/DetailedDirections'
fare:
$ref: '#/components/schemas/Fare'
geolocation:
$ref: '#/components/schemas/Geolocation'
notes:
type: string
x-examples:
- Notes about this vehicle transfer.
orderId:
type: string
x-examples:
- ABC123-LMNOP
payer:
$ref: '#/components/schemas/Company'
reconciliationCode:
type: string
x-examples:
- RBCON2020
states:
$ref: '#/components/schemas/States'
status:
type: string
enum:
- DRAFT
- READY
- AVAILABLE
- CLAIMED
- UNCLAIMED
- APPROVED
- ASSIGNED
- REJECTED
- ACCEPTED
- DRIVER_ARRIVED
- PICKED_UP
- SIGNATURE_ON_PICKUP
- PROVIDED_ETA_DROPOFF
- UNLOADED
- DELIVERED
- CANCELED
- COMPLETE
- ERROR
description: See the Vehicle Transfer Order Statuses guide for detailed information.
timeline:
type: array
items:
$ref: '#/components/schemas/Event'
transporter:
$ref: '#/components/schemas/Company'
dedicatedTransporter:
$ref: '#/components/schemas/Company'
canceled:
$ref: '#/components/schemas/Canceled'
errors:
type: array
items:
$ref: '#/components/schemas/Error'
labels:
type: array
items:
type: object
canCancel:
type: boolean
inspections:
type: array
items:
$ref: '#/components/schemas/InspectionSummary'
preferredTransporters:
type: array
items:
$ref: '#/components/schemas/Company'
required:
- id
- referenceNumber
- created
- vehicle
- directions
- fare
- orderId
- status
Created:
type: object
title: Created
properties:
byCompany:
$ref: '#/components/schemas/Company'
byUser:
type: string
description: User ID
x-examples:
- 7ae99113-09fd-4838-917a-a7d9636c2f8c
byUserFullName:
type: string
date:
type: string
description: Datetime in ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
Distance:
type: object
title: Distance
properties:
distanceInMeters:
type: integer
format: int64
distanceInMiles:
type: number
format: double
durationInSeconds:
type: integer
format: int64
Error:
type: object
title: Error
description: A common Error object.
properties:
code:
type: string
enum:
- INVALID_VEHICLE_TRANSFER_ORDER
- INVALID_ADDRESS
- INVALID_VEHICLE
x-examples:
- INVALID_VEHICLE_TRANSFER_ORDER
message:
type: string
description: The error message.
x-examples:
- A vehicle requested has an invalid VIN.
field:
type: string
x-examples:
- vin
required:
- code
VehicleTransferOrderIds:
type: object
title: VehicleTransferOrderIds
properties:
id:
type: string
x-examples:
- f7a7a77e-1afb-47b9-8d19-92591590ed33
required:
- id
States:
type: object
title: States
properties:
accepted:
$ref: '#/components/schemas/State'
claimed:
$ref: '#/components/schemas/State'
delivered:
$ref: '#/components/schemas/StateLocation'
pickedUp:
$ref: '#/components/schemas/StateLocation'
Fare:
type: object
title: Fare
properties:
amount:
type: number
format: double
items:
type: array
items:
$ref: '#/components/schemas/Item'
name:
type: string
options:
type: array
items:
type: string
promotionCode:
type: string
x-examples:
- RBCON19
Pageable:
type: object
title: Pageable
properties:
offset:
type: integer
format: int64
pageNumber:
type: integer
format: int32
pageSize:
type: integer
format: int32
paged:
type: boolean
sort:
$ref: '#/components/schemas/Sort'
unpaged:
type: boolean
Sort:
type: object
title: Sort
properties:
empty:
type: boolean
sorted:
type: boolean
unsorted:
type: boolean
TruckSpecifications:
type: object
title: TruckSpecifications
properties:
rearAxle:
type: string
State:
type: object
title: State
properties:
time:
type: string
description: Datetime in ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
DetailedDirections:
type: object
title: DetailedDirections
properties:
distance:
$ref: '#/components/schemas/Distance'
dropoff:
$ref: '#/components/schemas/Location'
pickup:
$ref: '#/components/schemas/Location'
PageVehicleTransferOrder:
type: object
title: PageVehicleTransferOrder
properties:
content:
type: array
items:
$ref: '#/components/schemas/VehicleTransferOrder'
empty:
type: boolean
first:
type: boolean
last:
type: boolean
number:
type: integer
format: int32
numberOfElements:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
size:
type: integer
format: int32
sort:
$ref: '#/components/schemas/Sort'
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int32
required:
- content
- empty
- first
- last
- number
- numberOfElements
- pageable
- size
- sort
- totalElements
- totalPages
TempFile:
type: object
title: TempFile
properties:
resourcePath:
type: string
VehiclePatch:
type: object
title: VehiclePatch
properties:
color:
type: string
notes:
type: string
stockNumber:
type: string
Order:
type: object
title: Order
properties:
id:
type: string
x-examples:
- 151ff45d-9fcc-4df6-b221-cd7fcb1d7614
referenceNumber:
type: string
x-examples:
- S-000035994
vehicleTransferOrders:
type: array
items:
$ref: '#/components/schemas/VehicleTransferOrderIds'
created:
$ref: '#/components/schemas/Created'
owner:
$ref: '#/components/schemas/Company'
payer:
$ref: '#/components/schemas/Company'
canceled:
$ref: '#/components/schemas/Canceled'
labels:
type: array
items:
type: string
notes:
type: string
x-examples:
- Big May 1st delivery.
status:
type: string
type:
type: string
enum:
- BASIC
- SWAP
completedDate:
type: string
format: date-time
errors:
type: array
items:
$ref: '#/components/schemas/Error'
fare:
type: array
items:
$ref: '#/components/schemas/FareItem'
dedicatedTransporter:
$ref: '#/components/schemas/Company'
preferredStatusExpiration:
type: string
preferredTransporters:
type: array
items:
$ref: '#/components/schemas/Company'
replacement:
$ref: '#/components/schemas/Replacement'
required:
- id
- referenceNumber
- vehicleTransferOrders
- created
- status
- type
Vehicle:
type: object
title: Vehicle
description: When creating an order, there are 2 options for providing the Vehicle information. [See here](/docs/shipping/ace1edcc412ad-vehicle-request-requirements)
properties:
color:
type: string
x-examples:
- Blue
isOperational:
type: boolean
x-examples:
- true
isOverSized:
type: boolean
x-examples:
- false
make:
type: string
x-examples:
- BMW
model:
type: string
x-examples:
- M3
notes:
type: string
x-examples:
- She's a beauty.
odometer:
type: integer
format: int32
stockNumber:
type: string
x-examples:
- '1234'
truckSpecifications:
$ref: '#/components/schemas/TruckSpecifications'
type:
type: string
vehicleMarket:
type: string
enum:
- LIGHT
- MEDIUM
- HEAVY
vehicleMeasurements:
$ref: '#/components/schemas/VehicleMeasurements'
vin:
type: string
x-examples:
- 2C3KA53G68H269241
year:
type: integer
format: int32
required:
- vin
VehicleTransferOrderExpanded:
type: object
title: VehicleTransferOrder
description: A Vehicle Transfer Order.
properties:
id:
type: string
x-examples:
- 7a765a49-6b21-4368-937e-8ce4981d8eff
referenceNumber:
type: string
x-examples:
- V-001035812
created:
$ref: '#/components/schemas/Created'
vehicle:
$ref: '#/components/schemas/Vehicle'
directions:
$ref: '#/components/schemas/DetailedDirections'
fare:
$ref: '#/components/schemas/Fare'
geolocation:
$ref: '#/components/schemas/Geolocation'
notes:
type: string
x-examples:
- Notes about this vehicle transfer.
order:
$ref: '#/components/schemas/Order'
payer:
$ref: '#/components/schemas/Company'
reconciliationCode:
type: string
x-examples:
- RBCON2020
states:
$ref: '#/components/schemas/States'
status:
type: string
enum:
- DRAFT
- READY
- AVAILABLE
- CLAIMED
- UNCLAIMED
- ASSIGNED
- REJECTED
- ACCEPTED
- DRIVER_ARRIVED
- PICKED_UP
- SIGNATURE_ON_PICKUP
- UNLOADED
- DELIVERED
- CANCELED
- COMPLETE
- ERROR
description: See the Vehicle Transfer Order Statuses guide for detailed information.
timeline:
type: array
items:
$ref: '#/components/schemas/Event'
transporter:
$ref: '#/components/schemas/Company'
dedicatedTransporter:
$ref: '#/components/schemas/Company'
canceled:
$ref: '#/components/schemas/Canceled'
errors:
type: array
items:
$ref: '#/components/schemas/Error'
labels:
type: array
items:
type: object
canCancel:
type: boolean
inspections:
type: array
items:
$ref: '#/components/schemas/InspectionSummary'
preferredTransporters:
type: array
items:
$ref: '#/components/schemas/Company'
required:
- id
- referenceNumber
- created
- vehicle
- directions
- fare
- status
Geolocation:
type: object
title: Geolocation
properties:
coordinates:
type: array
items:
type: number
format: double
type:
type: string
PageVehicleTransferOrderExpanded:
type: object
title: PageVehicleTransferOrderExpanded
properties:
content:
type: array
items:
$ref: '#/components/schemas/VehicleTransferOrderExpanded'
empty:
type: boolean
first:
type: boolean
last:
type: boolean
number:
type: integer
format: int32
numberOfElements:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
size:
type: integer
format: int32
sort:
$ref: '#/components/schemas/Sort'
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int32
required:
- content
- empty
- first
- last
- number
- numberOfElements
- pageable
- size
- sort
- totalElements
- totalPages
Window:
type: object
title: Window
properties:
confirmed:
type: boolean
start:
type: string
description: Datetime in ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
end:
type: string
description: Datetime in ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
priority:
type: integer
format: int32
AddressComponents:
type: object
title: AddressComponents
properties:
city:
type: string
country:
type: string
county:
type: string
postalCode:
type: string
state:
type: string
street:
type: string
streetNumber:
type: string
suite:
type: string
Location:
type: object
title: Location
properties:
address:
type: string
minLength: 1
addressComponents:
$ref: '#/components/schemas/AddressComponents'
auctionCode:
type: string
contact:
$ref: '#/components/schemas/Contact'
dealerCode:
type: string
geolocation:
$ref: '#/components/schemas/Geolocation'
eta:
$ref: '#/components/schemas/EstimatedTimeToArrival'
name:
type: string
notes:
type: string
type:
type: string
enum:
- business
- personal
windows:
type: array
items:
$ref: '#/components/schemas/Window'
required:
- address
LocationPatch:
type: object
title: LocationPatch
properties:
contact:
$ref: '#/components/schemas/Contact'
name:
type: string
notes:
type: string
StateLocation:
type: object
title: StateLocation
properties:
accuracy:
type: integer
format: int32
geolocation:
$ref: '#/components/schemas/Geolocation'
time:
type: string
description: Datetime in ISO 8601 format.
format: ISO 8601 datetime
x-examples:
- '2020-12-05T21:18:47+00:00'
securitySchemes:
Authorization:
type: apiKey
description: See the [Authentication Guide](/docs/shipping/b6b6c2d4906e9-authentication).
name: Authorization
in: header