Skip to main content

get​

get

Header Parameters
    authorization string required

    authorization

Request Body required

filter

    allTrips boolean
    customerUuids string[]
    dealerDepartmentUUIDList string[]
    dealerUuids string[]
    docStatuses string[]

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

    driverUuids string[]
    endApptTime string
    eventUuids string[]
    lastItemIndex int32
    pageNumber int32
    pageSize int32
    requesterUserUUID string
    rideTypes string[]

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

    sortOrder string

    Possible values: [APPT_TIME_ASC, APPT_TIME_DESC]

    source string

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

    startApptTime string
    subTripStatuses string[]

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

    tripStatuses 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
    statusCode int32
    totalCount int32
    tripViewDtos object[]
  • Array [
    • appointmentTime string
    assignedBy object
    departmentUuid string
    firstName string
    lastName string
    roleName string
    userUuid string
    uuid string
    createdDate string
    customer object
    dlVerified boolean
    firstName string
    insuranceVerified boolean
    lastName string
    signatureUrl string
    uuid string
    customerProfileToken string
    dealerOrder object
    orderNumber string
    serviceAdvisor object
    departmentUuid string
    firstName string
    lastName string
    roleName string
    userUuid string
    uuid string
    uuid string
    department object
    dealer object
    name string
    uuid string
    name string
    uuid string
    docStatus string

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

    driverPayments object[]
  • Array [
    • amountForMiles double
    amountForMinutes double
    amountForTrip double
    dollarPerMile double
    dollarPerMinute double
    dollarPerTrip double
    driverUuid string
    salariedTotal double
    totalAmount double
    tripDetails object
    distanceTravelledInMiles double
    endDrivingTime string
    endTime string
    inboundStartTime string
    maxSpeed double
    outboundCompleteTime string
    startDrivingTime string
    startTime string
    totalTimeInMinutes int32
  • ]
    • eventUuid 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]

    isValid boolean
    linkedAppointmentUuid string
    linkedTripUuids string[]
    loaner object
    bookingStatus string

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

    description string
    inspectionByDaUuid string
    inspectionUuid string
    isDropCar boolean
    isLoanerRequested boolean
    model string
    uuid string
    mustStartBy string
    optionalFields object
    property name* string
    parentEventUuid string
    primaryDriver object
    departmentUuid string
    firstName string
    lastName string
    roleName string
    userUuid string
    uuid string
    rideType string

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

    secondaryDriver object
    departmentUuid string
    firstName string
    lastName string
    roleName string
    userUuid string
    uuid string
    serviceAdvisor object
    departmentUuid string
    firstName string
    lastName string
    roleName string
    userUuid string
    uuid string
    subTrips object[]
  • Array [
    • destination object
    address string
    latitudeDouble double
    longitude double
    distanceInMiles double
    driver object
    departmentUuid string
    firstName string
    lastName string
    roleName string
    userUuid string
    uuid string
    origin object
    address string
    latitudeDouble double
    longitude double
    rideType string

    Possible values: [OUTBOUND, INBOUND]

    status string

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

    subTripUuid string
    timeInMinutes double
    transportType string

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

  • ]
    • swappedLoaner object
    bookingStatus string

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

    description string
    inspectionByDaUuid string
    inspectionUuid string
    isDropCar boolean
    isLoanerRequested boolean
    model string
    uuid string
    tripStatus string

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

    updatedBy object
    departmentUuid string
    firstName string
    lastName string
    roleName string
    userUuid string
    uuid string
    vehicle object
    estimatedMileage string
    inspectionByDaUuid string
    inspectionUuid string
    make string
    model string
    uuid string
    vin string
    year string
    version int64
  • ]
    • warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
POST /v3/trip-view/list

Request

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

  "allTrips": true,

  "customerUuids": [

    "string"

  ],

  "dealerDepartmentUUIDList": [

    "string"

  ],

  "dealerUuids": [

    "string"

  ],

  "docStatuses": [

    "UPLOAD_PENDING"

  ],

  "driverUuids": [

    "string"

  ],

  "endApptTime": "string",

  "eventUuids": [

    "string"

  ],

  "lastItemIndex": 0,

  "pageNumber": 0,

  "pageSize": 0,

  "requesterUserUUID": "string",

  "rideTypes": [

    "PICKUP_CUSTOMER"

  ],

  "sortOrder": "APPT_TIME_ASC",

  "source": "DEALER_APP",

  "startApptTime": "string",

  "subTripStatuses": [

    "DRAFT"

  ],

  "tripStatuses": [

    "DRAFT"

  ]

}
curl / cURL
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip-view/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "allTrips": true,
  "customerUuids": [
    "string"
  ],
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "dealerUuids": [
    "string"
  ],
  "docStatuses": [
    "UPLOAD_PENDING"
  ],
  "driverUuids": [
    "string"
  ],
  "endApptTime": "string",
  "eventUuids": [
    "string"
  ],
  "lastItemIndex": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "requesterUserUUID": "string",
  "rideTypes": [
    "PICKUP_CUSTOMER"
  ],
  "sortOrder": "APPT_TIME_ASC",
  "source": "DEALER_APP",
  "startApptTime": "string",
  "subTripStatuses": [
    "DRAFT"
  ],
  "tripStatuses": [
    "DRAFT"
  ]
}'