Skip to main content

Fetch trip details​

End-point to fetch trip details using a list of trip's identifier.

Header Parameters
    authorization string required

    Base64 encoded basic auth

Request Body required

Request to fetch trips with different filters

    customerUUIDs string[]
    dealerDepartmentUUIDList string[]
    dealerOrderUUIDs string[]
    dealerUUIDList string[]
    driverUUIDs string[]
    endAppointmentTime string
    lastAppointmentTime string
    pageSize int32
    requesterUserUUID string
    rideType string

    Possible values: [PICKUP_CUSTOMER, PICKUP_VEHICLE, DROPOFF_CUSTOMER, DROPOFF_VEHICLE, LOANER_SWAP, MISCELLANEOUS, RIDE_SHARE]

    source string

    Possible values: [DEALER_APP, WEB, PND_API, EXTERNAL_CONTROLLER]

    startAppointmentTime string
    tripStatusList string[]

    Possible values: [DRAFT, AUTO_DRAFT, ASSIGNED, UNASSIGNED, OUTBOUND, INBOUND, READY_TO_DRIVE, AT_DESTINATION, AT_DEALERSHIP, COMPLETED, CANCELLED]

Responses

OK

Schema
    error object
    errorCode string
    errorDescription string
    metadata object
    property name* string
    pickupDeliveryTripsList object[]
  • Array [
    • appointmentTime string
    assignedByDealerAssociateUUID string
    clientSideLogs string[]
    createdDate string
    customerDlVerified boolean
    customerFirstName string
    customerInsuranceVerified boolean
    customerLastName string
    customerProfileToken string
    customerSignatureUrl string
    customerUUID string
    customerVehicleInspectionId string
    dealerDepartmentUUID string
    dealerName string
    dealerOrderUUID string
    dealerUUID string
    destLocationLat double
    destLocationLon double
    destinationAddress string
    docStatus string

    Possible values: [UPLOAD_PENDING, VERIFICATION_PENDING, VERIFIED, REQUEST_ITEMS, VERIFY_ITEMS, PREVIEW_ITEMS]

    eventUUID string
    internalNote object
    attachmentList string[]
    customerId int64
    customerUUID string
    dealerAssociateId int64
    messageText string
    recipientDAs object[]
  • Array [
    • dealerAssociateID int64
    dealerAssociateName string
    dealerAssociateUserUuid string
    isAssignee boolean
  • ]
    • removedDAs object[]
  • Array [
    • dealerAssociateID int64
    dealerAssociateName string
    dealerAssociateUserUuid string
    isAssignee boolean
  • ]
    • internalNoteMessageUUIDList string[]
    internalRideType string

    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]

    isDropCar boolean
    isValid boolean
    linkedAppointmentUuid string
    linkedTripUuids string[]
    loanerDescription string
    loanerModel string
    loanerVehicleInspectionId string
    loanerVehicleRequired boolean
    loanerVehicleUuid string
    mustStartBy string
    optionalFields object
    property name* string
    originAddress string
    originLocationLat double
    originLocationLon double
    parentEventUUID string
    primaryDriverFirstName string
    primaryDriverLastName string
    primaryDriverUUID string
    rideType string

    Possible values: [PICKUP_CUSTOMER, PICKUP_VEHICLE, DROPOFF_CUSTOMER, DROPOFF_VEHICLE, LOANER_SWAP, MISCELLANEOUS, RIDE_SHARE]

    roNumber string
    secondaryDriverFirstName string
    secondaryDriverLastName string
    secondaryDriverUUID string
    sendMessageToCustomer boolean
    serviceAdvisorName string
    serviceAdvisorUUID string
    sharedRidePartner string

    Possible values: [UBER, LYFT, OLA]

    sharedRideRequest object
    bookingType string

    Possible values: [GENERAL, QUICK_BOOK]

    createdByUserFname string
    createdByUserLname string
    createdByUserUUID string
    customerFname string
    customerLname string
    customerUUID string
    dealerUUID string
    departmentUuid string
    fareValueAtBooking double
    metadata string
    module string

    Possible values: [PICKUP_DELIVERY]

    orderNumber string
    orderUUID string
    phoneNumber string
    rideType string

    Possible values: [PICKUP_CUSTOMER, DROPOFF_CUSTOMER, PICKUP_VEHICLE, DROPOFF_VEHICLE, MISCELLANEOUS]

    serviceAdvisorFname string
    serviceAdvisorLname string
    serviceAdvisorUUID string
    updatedByUserFname string
    updatedByUserLname string
    updatedByUserUUID string
    sharedRideResponse object
    error object
    errorCode string
    errorDescription string
    metadata object
    property name* string
    sharedRideUUID string
    statusCode int32
    warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
    • subTrips object[]
  • Array [
    • driverFirstName string
    driverLastName string
    driverUUID string
    subRideType string

    Possible values: [OUTBOUND, INBOUND]

    subTripStatus string

    Possible values: [DRAFT, AUTO_DRAFT, ASSIGNED, UNASSIGNED, READY_TO_DRIVE, STARTED, IN_PROGRESS, AT_DEALERSHIP, COMPLETED, CANCELLED]

    subTripUUID string
    transportType string

    Possible values: [DEALERSHIP_VEHICLE, CUSTOMER_VEHICLE, THIRD_PARTY_VEHICLE, AS_PASSENGER, SHARED_RIDE_SERVICE]

  • ]
    • swappedLoanerDescription string
    swappedLoanerVehicleUuid string
    tripStatus string

    Possible values: [DRAFT, AUTO_DRAFT, ASSIGNED, UNASSIGNED, OUTBOUND, INBOUND, READY_TO_DRIVE, AT_DESTINATION, AT_DEALERSHIP, COMPLETED, CANCELLED]

    unlinkedInternalNoteMessageUuidList string[]
    updatedByDealerAssociateUuid string
    vehicleBookingStatus string

    Possible values: [REQUEST_RESERVATION, RESERVATION_APPROVED, RESERVATION_CONFIRMED, CANCEL_RESERVATION, RESERVATION_CANCELLED]

    vehicleIdentifiers object
    estimatedMileage string
    id int64
    vehicleMake string
    vehicleModel string
    vehicleUuid string
    vehicleYear string
    vin string
    version int64
  • ]
    • statusCode int32
    warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
POST /v3/event/list

Request

Base URL
//api.mykaarma.com/pickupdelivery
authorization — header required
Body required
{

  "customerUUIDs": [

    "string"

  ],

  "dealerDepartmentUUIDList": [

    "string"

  ],

  "dealerOrderUUIDs": [

    "string"

  ],

  "dealerUUIDList": [

    "string"

  ],

  "driverUUIDs": [

    "string"

  ],

  "endAppointmentTime": "string",

  "lastAppointmentTime": "string",

  "pageSize": 0,

  "requesterUserUUID": "string",

  "rideType": "PICKUP_CUSTOMER",

  "source": "DEALER_APP",

  "startAppointmentTime": "string",

  "tripStatusList": [

    "DRAFT"

  ]

}
curl / cURL
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/event/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUIDs": [
    "string"
  ],
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "dealerOrderUUIDs": [
    "string"
  ],
  "dealerUUIDList": [
    "string"
  ],
  "driverUUIDs": [
    "string"
  ],
  "endAppointmentTime": "string",
  "lastAppointmentTime": "string",
  "pageSize": 0,
  "requesterUserUUID": "string",
  "rideType": "PICKUP_CUSTOMER",
  "source": "DEALER_APP",
  "startAppointmentTime": "string",
  "tripStatusList": [
    "DRAFT"
  ]
}'