Fetch trips of specific ride type for customer
End-point to fetch a list of trips of a specific ride type for a customer. This end-point would return all trips (past and future) for the customer. Different ride types which we support are Pickup Vehicle, Pickup Customer, Dropoff Customer, Dropoff Vehicle, Loaner Swap and Miscellaneous.
Path Parameters
Unique identifier for a customer
Header Parameters
Base64 encoded basic auth
Request Body required
Request to fetch trip by Ride Type and customer
Possible values: [PICKUP_CUSTOMER
, PICKUP_VEHICLE
, DROPOFF_CUSTOMER
, DROPOFF_VEHICLE
, LOANER_SWAP
, MISCELLANEOUS
, RIDE_SHARE
]
Possible values: [DEALER_APP
, WEB
, PND_API
, EXTERNAL_CONTROLLER
]
- 200
- 201
- 401
- 403
- 404
OK
Schema
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
error object
metadata object
pickupDeliveryTripsList object[]
Possible values: [UPLOAD_PENDING
, VERIFICATION_PENDING
, VERIFIED
, REQUEST_ITEMS
, VERIFY_ITEMS
, PREVIEW_ITEMS
]
internalNote object
recipientDAs object[]
removedDAs object[]
Possible values: [PICKUP_VEHICLE_NO_LOANER
, PICKUP_VEHICLE_WITH_LOANER
, PICKUP_VEHICLE_2_DRIVER_WITH_LOANER
, PICKUP_CUSTOMER_NO_LOANER
, PICKUP_CUSTOMER_WITH_LOANER
, DROPOFF_CUSTOMER_NO_LOANER
, DROPOFF_CUSTOMER_WITH_LOANER
, DROPOFF_VEHICLE_WITH_LOANER
, DROPOFF_VEHICLE_NO_LOANER
, DROPOFF_VEHICLE_2_DRIVER_WITH_LOANER
, LOANER_SWAP
, MISCELLANEOUS_NO_LOANER
, MISCELLANEOUS_WITH_LOANER
, RIDESHARE_PICKUP_CUSTOMER
, RIDESHARE_DROPOFF_CUSTOMER
, RIDESHARE_PICKUP_VEHICLE
, RIDESHARE_DROPOFF_VEHICLE
, RIDESHARE_MISCELLANEOUS
]
optionalFields object
Possible values: [PICKUP_CUSTOMER
, PICKUP_VEHICLE
, DROPOFF_CUSTOMER
, DROPOFF_VEHICLE
, LOANER_SWAP
, MISCELLANEOUS
, RIDE_SHARE
]
Possible values: [UBER
, LYFT
, OLA
]
sharedRideRequest object
Possible values: [GENERAL
, QUICK_BOOK
]
Possible values: [PICKUP_DELIVERY
]
Possible values: [PICKUP_CUSTOMER
, DROPOFF_CUSTOMER
, PICKUP_VEHICLE
, DROPOFF_VEHICLE
, MISCELLANEOUS
]
sharedRideResponse object
error object
metadata object
warnings object[]
subTrips object[]
Possible values: [OUTBOUND
, INBOUND
]
Possible values: [DRAFT
, AUTO_DRAFT
, ASSIGNED
, UNASSIGNED
, READY_TO_DRIVE
, STARTED
, IN_PROGRESS
, AT_DEALERSHIP
, COMPLETED
, CANCELLED
]
Possible values: [DEALERSHIP_VEHICLE
, CUSTOMER_VEHICLE
, THIRD_PARTY_VEHICLE
, AS_PASSENGER
, SHARED_RIDE_SERVICE
]
Possible values: [DRAFT
, AUTO_DRAFT
, ASSIGNED
, UNASSIGNED
, OUTBOUND
, INBOUND
, READY_TO_DRIVE
, AT_DESTINATION
, AT_DEALERSHIP
, COMPLETED
, CANCELLED
]
Possible values: [REQUEST_RESERVATION
, RESERVATION_APPROVED
, RESERVATION_CONFIRMED
, CANCEL_RESERVATION
, RESERVATION_CANCELLED
]
vehicleIdentifiers object
warnings object[]
{
"error": {
"errorCode": "string",
"errorDescription": "string",
"metadata": {}
},
"pickupDeliveryTripsList": [
{
"appointmentTime": "string",
"assignedByDealerAssociateUUID": "string",
"clientSideLogs": [
"string"
],
"createdDate": "string",
"customerDlVerified": true,
"customerFirstName": "string",
"customerInsuranceVerified": true,
"customerLastName": "string",
"customerProfileToken": "string",
"customerSignatureUrl": "string",
"customerUUID": "string",
"customerVehicleInspectionId": "string",
"dealerDepartmentUUID": "string",
"dealerName": "string",
"dealerOrderUUID": "string",
"dealerUUID": "string",
"destLocationLat": 0,
"destLocationLon": 0,
"destinationAddress": "string",
"docStatus": "UPLOAD_PENDING",
"eventUUID": "string",
"internalNote": {
"attachmentList": [
"string"
],
"customerId": 0,
"customerUUID": "string",
"dealerAssociateId": 0,
"messageText": "string",
"recipientDAs": [
{
"dealerAssociateID": 0,
"dealerAssociateName": "string",
"dealerAssociateUserUuid": "string",
"isAssignee": true
}
],
"removedDAs": [
{
"dealerAssociateID": 0,
"dealerAssociateName": "string",
"dealerAssociateUserUuid": "string",
"isAssignee": true
}
]
},
"internalNoteMessageUUIDList": [
"string"
],
"internalRideType": "PICKUP_VEHICLE_NO_LOANER",
"isDropCar": true,
"isValid": true,
"linkedAppointmentUuid": "string",
"linkedTripUuids": [
"string"
],
"loanerDescription": "string",
"loanerModel": "string",
"loanerVehicleInspectionId": "string",
"loanerVehicleRequired": true,
"loanerVehicleUuid": "string",
"mustStartBy": "string",
"optionalFields": {},
"originAddress": "string",
"originLocationLat": 0,
"originLocationLon": 0,
"parentEventUUID": "string",
"primaryDriverFirstName": "string",
"primaryDriverLastName": "string",
"primaryDriverUUID": "string",
"rideType": "PICKUP_CUSTOMER",
"roNumber": "string",
"secondaryDriverFirstName": "string",
"secondaryDriverLastName": "string",
"secondaryDriverUUID": "string",
"sendMessageToCustomer": true,
"serviceAdvisorName": "string",
"serviceAdvisorUUID": "string",
"sharedRidePartner": "UBER",
"sharedRideRequest": {
"bookingType": "GENERAL",
"createdByUserFname": "string",
"createdByUserLname": "string",
"createdByUserUUID": "string",
"customerFname": "string",
"customerLname": "string",
"customerUUID": "string",
"dealerUUID": "string",
"departmentUuid": "string",
"fareValueAtBooking": 0,
"metadata": "string",
"module": "PICKUP_DELIVERY",
"orderNumber": "string",
"orderUUID": "string",
"phoneNumber": "string",
"rideType": "PICKUP_CUSTOMER",
"serviceAdvisorFname": "string",
"serviceAdvisorLname": "string",
"serviceAdvisorUUID": "string",
"updatedByUserFname": "string",
"updatedByUserLname": "string",
"updatedByUserUUID": "string"
},
"sharedRideResponse": {
"error": {
"errorCode": "string",
"errorDescription": "string",
"metadata": {}
},
"sharedRideUUID": "string",
"statusCode": 0,
"warnings": [
{
"warningCode": "string",
"warningDescription": "string"
}
]
},
"subTrips": [
{
"driverFirstName": "string",
"driverLastName": "string",
"driverUUID": "string",
"subRideType": "OUTBOUND",
"subTripStatus": "DRAFT",
"subTripUUID": "string",
"transportType": "DEALERSHIP_VEHICLE"
}
],
"swappedLoanerDescription": "string",
"swappedLoanerVehicleUuid": "string",
"tripStatus": "DRAFT",
"unlinkedInternalNoteMessageUuidList": [
"string"
],
"updatedByDealerAssociateUuid": "string",
"vehicleBookingStatus": "REQUEST_RESERVATION",
"vehicleIdentifiers": {
"estimatedMileage": "string",
"id": 0,
"vehicleMake": "string",
"vehicleModel": "string",
"vehicleUuid": "string",
"vehicleYear": "string",
"vin": "string"
},
"version": 0
}
],
"statusCode": 0,
"warnings": [
{
"warningCode": "string",
"warningDescription": "string"
}
]
}
Created
Unauthorized
Forbidden
Not Found