Car hire live pricing API (1.0)

CarHireService

CarHireService_CreateSearch

Authorizations:

UserAuth

Request Body schema: application/json
required

The request body for Car Hire Search Request method

	object (rpccarhireliveQuery)
userIp	string (User Ip) Optional field Ip of the caller

Responses

Request samples

Payload

Content type

application/json

{"query": {"market": "string",
"locale": "string",
"currency": "string",
"pickUpLocation": {"entityId": "string",
"coordinates": {"latitude": 0.1,
"longitude": 0.1
}
},
"dropOffLocation": {"entityId": "string",
"coordinates": {"latitude": 0.1,
"longitude": 0.1
}
},
"pickUpDate": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"dropOffDate": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"includedAgentIds": ["string"
],
"excludedAgentIds": ["string"
],
"driverAge": 0
},
"userIp": "string"
}

Response samples

Content type

application/json

{"sessionToken": "string",
"status": "RESULT_STATUS_UNSPECIFIED",
"content": {"results": {"quotes": {"property1": {"sippCode": "string",
"vendorId": "string",
"agentId": "string",
"price": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"pricePerDay": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"deeplinkUrl": "string",
"pickupMethod": "PICKUP_METHOD_UNSPECIFIED",
"payType": "PAY_TYPE_UNSPECIFIED",
"additions": {"freeCancellation": true,
"freeBreakdownAssistance": true,
"unlimitedMileage": true,
"additionalDriversFee": {"paid": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"free": {"number": 0,
"minAge": 0
}
},
"insurance": {"theftProtection": true,
"freeCollisionWaiver": true,
"thirdPartyCover": true
},
"oneWaySurcharge": true,
"youngDriverSurcharge": true,
"excessInsurance": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"fuel": {"policy": "FUEL_POLICY_UNSPECIFIED",
"fair": true,
"type": "FUEL_TYPE_UNSPECIFIED"
},
"includedMileage": {"distance": "string",
"unit": "DISTANCE_UNIT_UNSPECIFIED"
}
},
"pickupLocation": {"distanceToSearchKm": 0.1,
"geo": {"latitude": 0.1,
"longitude": 0.1
},
"address": "string"
},
"dropoffLocation": {"distanceToSearchKm": 0.1,
"geo": {"latitude": 0.1,
"longitude": 0.1
},
"address": "string"
},
"pickupType": "PICKUP_TYPE_UNSPECIFIED",
"vehicleName": "string",
"imageUrl": "string"
},
"property2": {"sippCode": "string",
"vendorId": "string",
"agentId": "string",
"price": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"pricePerDay": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"deeplinkUrl": "string",
"pickupMethod": "PICKUP_METHOD_UNSPECIFIED",
"payType": "PAY_TYPE_UNSPECIFIED",
"additions": {"freeCancellation": true,
"freeBreakdownAssistance": true,
"unlimitedMileage": true,
"additionalDriversFee": {"paid": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"free": {"number": 0,
"minAge": 0
}
},
"insurance": {"theftProtection": true,
"freeCollisionWaiver": true,
"thirdPartyCover": true
},
"oneWaySurcharge": true,
"youngDriverSurcharge": true,
"excessInsurance": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"fuel": {"policy": "FUEL_POLICY_UNSPECIFIED",
"fair": true,
"type": "FUEL_TYPE_UNSPECIFIED"
},
"includedMileage": {"distance": "string",
"unit": "DISTANCE_UNIT_UNSPECIFIED"
}
},
"pickupLocation": {"distanceToSearchKm": 0.1,
"geo": {"latitude": 0.1,
"longitude": 0.1
},
"address": "string"
},
"dropoffLocation": {"distanceToSearchKm": 0.1,
"geo": {"latitude": 0.1,
"longitude": 0.1
},
"address": "string"
},
"pickupType": "PICKUP_TYPE_UNSPECIFIED",
"vehicleName": "string",
"imageUrl": "string"
}
},
"agents": {"property1": {"name": "string",
"rating": 0.1,
"logoUrl": "string"
},
"property2": {"name": "string",
"rating": 0.1,
"logoUrl": "string"
}
},
"vendors": {"property1": {"id": "string",
"name": "string",
"logoUrl": "string"
},
"property2": {"id": "string",
"name": "string",
"logoUrl": "string"
}
}
},
"sortingOptions": {"cheapest": [{"score": 0.1,
"quoteId": "string"
}
]
}
}
}

CarHireService_PollSearch

Authorizations:

UserAuth

path Parameters

sessionToken

required

string

Session token

Required field The token is usually provided by the create search response and has to be re-used for all poll calls until complete set of results is provided

Responses

Response samples

Content type

application/json

{"sessionToken": "string",
"status": "RESULT_STATUS_UNSPECIFIED",
"content": {"results": {"quotes": {"property1": {"sippCode": "string",
"vendorId": "string",
"agentId": "string",
"price": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"pricePerDay": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"deeplinkUrl": "string",
"pickupMethod": "PICKUP_METHOD_UNSPECIFIED",
"payType": "PAY_TYPE_UNSPECIFIED",
"additions": {"freeCancellation": true,
"freeBreakdownAssistance": true,
"unlimitedMileage": true,
"additionalDriversFee": {"paid": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"free": {"number": 0,
"minAge": 0
}
},
"insurance": {"theftProtection": true,
"freeCollisionWaiver": true,
"thirdPartyCover": true
},
"oneWaySurcharge": true,
"youngDriverSurcharge": true,
"excessInsurance": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"fuel": {"policy": "FUEL_POLICY_UNSPECIFIED",
"fair": true,
"type": "FUEL_TYPE_UNSPECIFIED"
},
"includedMileage": {"distance": "string",
"unit": "DISTANCE_UNIT_UNSPECIFIED"
}
},
"pickupLocation": {"distanceToSearchKm": 0.1,
"geo": {"latitude": 0.1,
"longitude": 0.1
},
"address": "string"
},
"dropoffLocation": {"distanceToSearchKm": 0.1,
"geo": {"latitude": 0.1,
"longitude": 0.1
},
"address": "string"
},
"pickupType": "PICKUP_TYPE_UNSPECIFIED",
"vehicleName": "string",
"imageUrl": "string"
},
"property2": {"sippCode": "string",
"vendorId": "string",
"agentId": "string",
"price": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"pricePerDay": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"deeplinkUrl": "string",
"pickupMethod": "PICKUP_METHOD_UNSPECIFIED",
"payType": "PAY_TYPE_UNSPECIFIED",
"additions": {"freeCancellation": true,
"freeBreakdownAssistance": true,
"unlimitedMileage": true,
"additionalDriversFee": {"paid": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"free": {"number": 0,
"minAge": 0
}
},
"insurance": {"theftProtection": true,
"freeCollisionWaiver": true,
"thirdPartyCover": true
},
"oneWaySurcharge": true,
"youngDriverSurcharge": true,
"excessInsurance": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED",
"updateStatus": "PRICE_UPDATE_STATUS_UNSPECIFIED"
},
"fuel": {"policy": "FUEL_POLICY_UNSPECIFIED",
"fair": true,
"type": "FUEL_TYPE_UNSPECIFIED"
},
"includedMileage": {"distance": "string",
"unit": "DISTANCE_UNIT_UNSPECIFIED"
}
},
"pickupLocation": {"distanceToSearchKm": 0.1,
"geo": {"latitude": 0.1,
"longitude": 0.1
},
"address": "string"
},
"dropoffLocation": {"distanceToSearchKm": 0.1,
"geo": {"latitude": 0.1,
"longitude": 0.1
},
"address": "string"
},
"pickupType": "PICKUP_TYPE_UNSPECIFIED",
"vehicleName": "string",
"imageUrl": "string"
}
},
"agents": {"property1": {"name": "string",
"rating": 0.1,
"logoUrl": "string"
},
"property2": {"name": "string",
"rating": 0.1,
"logoUrl": "string"
}
},
"vendors": {"property1": {"id": "string",
"name": "string",
"logoUrl": "string"
},
"property2": {"id": "string",
"name": "string",
"logoUrl": "string"
}
}
},
"sortingOptions": {"cheapest": [{"score": 0.1,
"quoteId": "string"
}
]
}
}
}

Car hire live pricing API (1.0)

CarHireService

CarHireService_CreateSearch

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

CarHireService_PollSearch

Authorizations:

path Parameters

Responses

Response samples

Request Body schema: application/json
required