Skip to main content

How to fetch a trip

This document is designed to help you understand how you can fetch a trip using the trip UUID. To fetch a trip, 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 fetching a trip -

  • 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. {{tripUUID}} - UUID of the trip you want to fetch
  5. {{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/trip/{{tripUUID}}' \
--header 'Authorization: {{basic_auth_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"requesterUserUUID": "{{requesterUserUuid}}",
"dealerDepartmentUUIDList": [
"{{dealerDepartmentUuid}}"
],
"dealerUUID": "{{dealerUuid}}"
}'
  • Response
{
"statusCode": integer,
"error": {
"errorCode": "string",
"errorDescription": "string",
"metadata": "string"
},
"warnings": [
{
"warningCode": "string",
"warningDescription": "string"
}
],
"pickupDeliveryTripsList": []
}