How to filter trips

This document is designed to help you understand how you can filter trips based on certain paramters. To get filtered trips list based on certain paramters, you first need your credentials. If you don't already have one, head over to the Authentication and Authorization page to see how you can request for credentials from us.

The endpoint mentioned below can help you with filtering out trips -

• Parameters Used:

1. {{requesterUserUuid}} - UUID of the user who is sending the fetch trips list request
2. {{dealerDepartmentUuid}} - UUID of the dealer department you want to fetch trips list for
3. {{dealerUuid}} - UUID of the dealer you want to filter trips list for
4. {{fromDate}} - Start of date range in which to filter trips. eg. "2023-01-01T00:00:00+0530"
5. {{toDate}} - End of date range in which to filter trips. eg. "2023-01-10T00:00:00+0530"
6. {{rideType}} - Ride type of trips to be fetched. Possible values are "PICKUP_CUSTOMER", "PICKUP_VEHICLE", "DROPOFF_CUSTOMER", "DROPOFF_VEHICLE", "LOANER_SWAP", "MISCELLANEOUS", "RIDE_SHARE"
7. {{basic_auth_token}} - Authorization: Basic "generate using username password"

• Scope: The service subscriber needs to have the following scope for the department in the request - pickupdelivery.trip.fetch

• Endpoint

curl --location --request POST 'https://api.mykaarma.com/pickupdelivery/v3/event/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{basic_auth_token}}' \
--data-raw '{
    "requesterUserUUID": "{{requesterUserUuid}}",
    "dealerDepartmentUUIDList": [
        "{{dealerDepartmentUuid}}"
    ],
    "startAppointmentTime": "{{fromDate}}",
    "endAppointmentTime": "{{toDate}}",
    "dealerUUIDList": [
        "{{dealerUuid}}"
    ],
    "driverUUIDs": [],
    "customerUUIDs": [],
    "dealerOrderUUIDs": [],
    "tripStatusList": [],
    "lastAppointmentTime": null,
    "pageSize": null,
    "rideType": "{{rideType}}"
}'

• Response

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