generate

generate

application/json

Request Body required

dealerFilter

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

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
metadata object
property name* string
statusCode int32
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string",
    "metadata": {}
  },
  "statusCode": 0,
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /v3/trip-view/generate

Request

Base URL

//api.mykaarma.com/pickupdelivery

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/generate' \
-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"
  ]
}'

python / requests

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip-view/generate' \
-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"
  ]
}'

go / native

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip-view/generate' \
-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"
  ]
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip-view/generate' \
-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"
  ]
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip-view/generate' \
-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"
  ]
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip-view/generate' \
-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"
  ]
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip-view/generate' \
-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"
  ]
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip-view/generate' \
-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"
  ]
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip-view/generate' \
-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"
  ]
}'