This document is intended for any transfer Partners considering connecting Carzenplus as a transfer service provider, The current document gives the partner platform all the needed information to kick-off the integration of Carzenplus Transfers Connectors. Carzenplus airport transfer APIs are designed using a RESTful architecture, which relies on predictable, resource-oriented URLs, and HTTP response codes to indicate errors. It uses built-in HTTP features, like HTTP authentication and HTTP verbs, supported by most HTTP clients. Please also note that our current API version is 1, and all endpoints described in this document will begin with /v1/. For online tests, please visit This Url. If you need an AccessKey ID, or AccessKey secret, please contact us.
Version : v1
Contact : Carzenplus Contact Email : it.group@carzenplus.com
- Host :
test.api.carzenplus.com
- BasePath :
/v1
- Schemes :
HTTPS
An AccessKey pair (AccessKey ID and AccessKey secret) is a set of security credentials for you to access the API of Carzenplus. The owner of an AccessKey pair has full access to the current account. Keep your AccessKey pair confidential.
signature = MD5 (AccessKey ID + AccessKey secret)
POST /transfer/query
The Query resource is the one used to search for available transfer solutions and to get the details and prices for each solution.
Type | Name | Description | Schema |
---|---|---|---|
Body | model required |
Query model | TransferQueryInfo |
Name | Description | Schema |
---|---|---|
code | 200 is success, others number is error flags | integer(int32) |
success | true or false | boolean |
request_id | Request unique id | string |
message | Message | string |
data | Response data, | TransferQueryVO |
server_time | Unix time | integer(int64) |
application/json
text/json
application/json
text/json
Request body
{
"authentication":{
"signature":"702f79097da2d8b2314cae3af31bf26d",
"access_key":"xBPbzY"
},
"pick_up":{
"name":"Xiaoshan Airport",
"latitude":30.236189,
"longitude":120.438842,
"address":"Hangzhou International Airport (HGH)"
},
"drop_off":{
"name":"Zhejiang University",
"latitude":30.308888,
"longitude":120.086499,
"address":"No. 866 Yuhangtang Road, Xihu District, Hangzhou, Zhejiang ,China Postal"
},
"passenger_info":{
"adults":1,
"children":1,
"infants":0
},
"luggage_info":{
"medium":1,
"small":1
},
"vehicle_info":{
"categories":["ECONOMY","STANDARD"],
"types":["SUV","SEDAN"]
},
"booking_time":1659507431,
"format_booking_time":"2022-06-03 12:03:51",
"flight_code":"CA1234",
"transfer_type":"Airport2Point",
"currency":"CNY"
}
Response 200 code 200
{
"code": 200,
"success": true,
"message": "Success",
"data": {
"currency": "CNY",
"transfer_type": "Airport2Point",
"transfer_services": [
{
"price": 135.00,
"description": "",
"service_code": "BabySeat",
"service_name": "Baby Seat",
"max_booking_count": 10
}
],
"transfer_vehicles": [
{
"description": "Audi or similar",
"price": 1425.60,
"vehicle_name": "A6 or similar",
"brand_name": "Audi or similar",
"vehicle_id": 1,
"max_passenger_quantity": 5,
"max_luggage_quantity": 1,
"vehicle_icon": "",
"transfer_ticket_info": {
"ticket": "kdb6JNE7J9dcoV91X2YiX2jqnmJYg923",
"expire_time": 1659693529
},
"category": "STANDARD",
"type": "SUV",
"free_waiting_time": 60,
"tags": [
{
"tag_name": "COVID-19 Prepared",
"tag_value": "COVID-19"
}
]
},
{
"description": "",
"price": 549.45,
"vehicle_name": "Q7 or similar",
"brand_name": "Audi or similar",
"vehicle_id": 2,
"max_passenger_quantity": 7,
"max_luggage_quantity": 5,
"vehicle_icon": "",
"transfer_ticket_info": {
"ticket": "BVuCP5fSVKzPsPF5yR9TxJPf1k0nWV8b",
"expire_time": 1659693529
},
"category": "STANDARD",
"type": "SUV",
"free_waiting_time": 60,
"tags": [
{
"tag_name": "COVID-19 Prepared",
"tag_value": "COVID-19"
}
]
},
{
"description": "",
"price": 867.24,
"vehicle_name": "GL8 or similar",
"brand_name": "Buick",
"vehicle_id": 3,
"max_passenger_quantity": 7,
"max_luggage_quantity": 7,
"vehicle_icon": "",
"transfer_ticket_info": {
"ticket": "9rMqVpWEo5Vb2mQ10BmeXEBvCS2OXk7M",
"expire_time": 1659693529
},
"category": "STANDARD",
"type": "SUV",
"free_waiting_time": 60,
"tags": [
{
"tag_name": "COVID-19 Prepared",
"tag_value": "COVID-19"
}
]
}
],
"provider": {
"name": "Carzen Plus",
"logo_url": ""
},
"meeting_points":[
{
"id":3,
"title":"M&G - San Francisco International Airport",
"description":"1. Please switch on your phone and connect to the airport WiFi.\r\n2. Collect your luggage, and head to Arrivals\r\n3. The driver will await you there\r\n4. If you are unable to find the driver, please contact the number that is provided on your VOUCHER.",
"picture":"https://misc-cn.carzenplus.com/upload/image/2303/2e0fee74a400000.png"
},
{
"id":4,
"title":"33333333333",
"description":"asdasdasd\r\nasdsad\r\nasdasdasd\r\nasdasd",
"picture":"https://misc-cn.carzenplus.com/upload/image/2303/2e1099158000000.png"
}
],
"duration_in_seconds": 3060,
"distance_in_meters": 47310
},
"request_id": "37a85acdafd74882",
"server_time": 1659691729
}
Response 200 code 201
{
"code": 201,
"success": false,
"message": "transfer_type is null",
"request_id": "cc2c661180c04ae3",
"server_time": 1657096186
}
POST /transfer/create
The Booking resource is used to reserve a Transfer and to get from the provider a confirmation number for the reservation.
Make a booking based on submitted criteria.
Before making a reservation, you must query first.
Type | Name | Description | Schema |
---|---|---|---|
Body | model required |
Query model | BookingCreateRequest |
Name | Description | Schema |
---|---|---|
code | 200 is success, others number is error flags | integer(int32) |
success | true or false | boolean |
request_id | Request unique id | string |
message | Message | string |
data | Response data, | BookingVO |
server_time | Unix time | integer(int64) |
application/json
text/json
application/json
text/json
Request body
{
"remark":"remark",
"authentication":{
"signature":"702f79097da2d8b2314cae3af31bf26d",
"access_key":"xBPbzY"
},
"transfer_ticket":"9rMqVpWEo5Vb2mQ10BmeXEBvCS2OXk7M",
"flight_code":"CA1234",
"transfer_type":"Airport2Point",
"currency":"CNY",
"partner_order_sn":"D1344068",
"pick_up":{
"name":"Xiaoshan Airport",
"latitude":30.236189,
"longitude":120.438842,
"address":"Hangzhou International Airport (HGH)"
},
"drop_off":{
"name":"Zhejiang University",
"latitude":30.308888,
"longitude":120.086499,
"address":"No. 866 Yuhangtang Road, Xihu District, Hangzhou, Zhejiang ,China Postal"
},
"passenger_info":{
"adults":1,
"children":1,
"infants":0
},
"passenger_contact_info":{
"passenger_name":"Zhang San",
"passenger_phone":"+8613888888888",
"passenger_email":"xx@gmail.com"
},
"luggage_info":{
"medium":1,
"small":1
},
"transfer_services":[
{
"quantity":1,
"code":"BabySeat",
"price":100.01,
"total_price":100.01
}
],
"price_detail":{
"transfer_fee":867.24,
"service_fee":135,
"total_fee":1002.24
},
"booking_time":1659692551
}
Response 200
code 200
{
"code": 200,
"success": true,
"message": "Success",
"data": {
"order_status": "WAIT_CONFIRM",
"order_sn": "SD2022080508361",
"partner_order_sn": "D1344068",
"flight_code": "CA1234",
"transfer_type": "Airport2Point",
"currency": "CNY",
"remark": "remark",
"pick_up": {
"name": "Xiaoshan Airport",
"latitude": 30.236189,
"longitude": 120.438842,
"address": "Hangzhou International Airport (HGH)"
},
"drop_off": {
"name": "Zhejiang University",
"latitude": 30.308888,
"longitude": 120.086499,
"address": "No. 866 Yuhangtang Road, Xihu District, Hangzhou, Zhejiang ,China Postal"
},
"passenger_info": {
"adults": 1,
"children": 1,
"infants": 0
},
"passenger_contact_info": {
"passenger_name": "Zhang San",
"passenger_phone": "+8613888888888",
"passenger_email": "xx@gmail.com",
"passenger_whats_app_account": null,
"passenger_wechat_account": null
},
"luggage_info": {
"medium": 1,
"small": 1
},
"transfer_services": [
{
"price": 100.01,
"quantity": 1,
"service_code": "BabySeat",
"service_name": "Baby Seat"
}
],
"transfer_vehicle": {
"color": null,
"plate_number": null,
"brand_name": "Buick",
"model": "GL8 or similar"
},
"provider": {
"name": "Carzen Plus",
"logo_url": null
},
"price_detail": {
"transfer_fee": 902.23,
"service_fee": 100.01,
"total_fee": 1002.24
},
"driver_info": null,
"booking_time": 1659692551
},
"request_id": "32c6425721f849d9",
"server_time": 1659692704
}
Response 200
code 201
{
"code": 201,
"success": false,
"message": "Transfer ticket is expired",
"request_id": "b47f25d1209b4e14",
"server_time": 1657193743
}
Response 200
code 201
{
"code": 201,
"success": false,
"message": "Transfer already exists.",
"request_id": "baae7f3059f64307",
"server_time": 1657194291
}
POST /transfer/cancel
The Cancellation resource is used to cancel a Transfer reservation and to get from Provider a cancel confirmation.
Type | Name | Description | Schema |
---|---|---|---|
Body | model required |
Cancel model | BookingCancelInfo |
Name | Description | Schema |
---|---|---|
code | 200 is success, others number is error flags | integer(int32) |
success | true or false | boolean |
request_id | Request unique id | string |
message | Message | string |
data | Response data, | BookingCancelVO |
server_time | Unix time | integer(int64) |
application/json
text/json
application/json
text/json
Request body
{
"authentication":{
"signature":"702f79097da2d8b2314cae3af31bf26d",
"access_key":"xBPbzY"
},
"reason":"Cancel Reason",
"order_sn":"SD2022080508361"
}
Response 200
code 200
{
"code": 200,
"success": true,
"message": "Success",
"data": {
"currency": "CNY",
"cancel_time": 1659693530,
"order_total_price": 1002.24,
"cancel_loss_fee": 1002.24,
"order_sn": "SD2022080508361",
"partner_order_sn": "D1344068",
"cancel_type": "ALL_LOSS_CANCEL"
},
"request_id": "9d26b69fda6f40e1",
"server_time": 1659693530
}
Response 200
code 201
{
"code": 201,
"success": false,
"message": "Booking not allow cancel.",
"request_id": "4592f48413f64e97",
"server_time": 1657242783
}
POST /transfer/detail
The Detail resource is used to view a Transfer order details.
Type | Name | Description | Schema |
---|---|---|---|
Body | model required |
Detail model | BookingDetailInfo |
Name | Description | Schema |
---|---|---|
code | 200 is success, others number is error flags | integer(int32) |
success | true or false | boolean |
request_id | Request unique id | string |
message | Message | string |
data | Response data, | BookingVO |
server_time | Unix time | integer(int64) |
application/json
text/json
application/json
text/json
Request body
{
"authentication":{
"signature":"702f79097da2d8b2314cae3af31bf26d",
"access_key":"xBPbzY"
},
"order_sn":"SD2022080508361"
}
Response 200 code 200
{
"code": 200,
"success": true,
"message": "Success",
"data": {
"order_status": "WAIT_DISPATCH",
"order_sn": "SD2022080508361",
"partner_order_sn": "D1344068",
"flight_code": "CA1234",
"transfer_type": "Airport2Point",
"currency": "CNY",
"remark": "remark",
"pick_up": {
"name": "Xiaoshan Airport",
"latitude": 30.236189,
"longitude": 120.438842,
"address": "Hangzhou International Airport (HGH)"
},
"drop_off": {
"name": "Zhejiang University",
"latitude": 30.308888,
"longitude": 120.086499,
"address": "No. 866 Yuhangtang Road, Xihu District, Hangzhou, Zhejiang ,China Postal"
},
"passenger_info": {
"adults": 1,
"children": 1,
"infants": 0
},
"passenger_contact_info": {
"passenger_name": "Zhang San",
"passenger_phone": "+8613888888888",
"passenger_email": "xx@gmail.com",
"passenger_whats_app_account": null,
"passenger_wechat_account": null
},
"luggage_info": {
"medium": 1,
"small": 1
},
"transfer_services": [
{
"price": 100.01,
"quantity": 1,
"service_code": "BabySeat",
"service_name": "Baby Seat"
}
],
"transfer_vehicle": {
"color": null,
"plate_number": null,
"brand_name": "Buick",
"model": "GL8 or similar"
},
"provider": {
"name": "Carzen Plus",
"logo_url": null
},
"price_detail": {
"transfer_fee": 902.23,
"service_fee": 100.01,
"total_fee": 1002.24
},
"driver_info": null,
"booking_time": 1659692551
},
"request_id": "a7e3e5edc11d476b",
"server_time": 1659692876
}
Response 200 code 201
{
"code": 201,
"success": false,
"message": "Booking not found.",
"request_id": "c5325fd4993647d2",
"server_time": 1657244947
}
Name | Description | Scheme |
---|---|---|
authentication required |
Authentication parameter | TransferAuthenticationInfo |
pick_up required |
Starting point information (address , name, latitude, longitude) | TransferPointInfo |
drop_off required |
End point information (address , name, latitude, longitude) | TransferPointInfo |
passenger_info required |
Number of passenger, include adults, children,infants | PassengerInfo |
luggage_info optional |
Requirements to luggage space to be supported by the vehicle | LuggageInfo |
vehicle_info optional |
Vehicle information | TransferVehicleInfo |
booking_time optional |
The booking time. unix timestamp | integer (int64) There are two fields: booking_time and format_booking_time, can choose either one, but must ensure that the selected field has a value. |
format_booking_time optional |
The booking Date Time. format yyyy-MM-dd HH:mm:ss | string There are two fields: booking_time and format_booking_time, can choose either one, but must ensure that the selected field has a value. The default time zone for the format_booking_time parameter should be the time zone of the pickup city |
flight_code optional |
The numeric flight number. | string |
transfer_type required |
The type of transfer. | enum Airport2Point Point2Airport Point2Point |
currency required |
TheCurrency code in ISO 4217 format. | string |
Name | Description | Scheme |
---|---|---|
access_key required |
AccessKey ID | string |
signature required |
MD5 (AccessKey ID + AccessKey secret) | string |
Name | Description | Scheme |
---|---|---|
name optional |
Point name | string |
address optional |
Point address details | string |
latitude optional |
Latitude | number (double) |
longitude optional |
Longitude | number (double) |
address
,latitude longitude
must be provided at least one.
Name | Description | Scheme |
---|---|---|
adults required |
Adult Quantity | integer(int32) |
children optional |
Children Quantity | integer(int32) |
infants optional |
Infants Quantity | integer(int32) |
Name | Description | Scheme |
---|---|---|
medium optional |
Medium Luggage Quantity | integer(int32) |
small optional |
Small Luggage Quantity | integer(int32) |
Name | Description | Scheme |
---|---|---|
categories optional |
Vehicle category | array enum ECONOMY STANDARD BUSINESS_CLASS FIRST_CLASS |
types optional |
Vehicle type | array enum SUV SEDAN VAN BUS LIMO |
Name | Description | Schema |
---|---|---|
code | 200 is success, others number is error flags | integer(int32) |
success | true or false | boolean |
request_id | Request unique id | string |
message | Message | string |
data | Response data, | <?> |
server_time | Unix time | integer(int64) |
Name | Description | Scheme |
---|---|---|
authentication required |
Authentication parameter | TransferAuthenticationInfo |
transfer_ticket required |
/transfer/query > transfer_vehicles > transfer_ticket_info > ticket |
string |
flight_code optional |
The numeric flight number. | string |
transfer_type required |
The type of transfer. | enum Airport2Point Point2Airport Point2Point |
currency required |
TheCurrency code in ISO 4217 format. | string |
remark optional |
Customer remark. | string |
partner_order_sn required |
Partner order number. | string |
pick_up required |
Starting point information (address , name, latitude, longitude) | TransferPointInfo |
drop_off required |
End point information (address , name, latitude, longitude) | TransferPointInfo |
passenger_info required |
Number of passenger, include adults, children,infants | PassengerInfo |
luggage_info optional |
Requirements to luggage space to be supported by the vehicle | LuggageInfo |
passenger_contact_info required |
Passengers’ information. Information about “main” passenger is required | PassengerContactInfo |
transfer_services required |
Platform model information, need to contact us to bind | <TransferServiceItem> array |
price_detail required |
Payment detail | OrderPriceDetail |
booking_time optional |
The booking time. unix timestamp | integer (int64) There are two fields: booking_time and format_booking_time, can choose either one, but must ensure that the selected field has a value. |
format_booking_time optional |
The booking Date Time. format yyyy-MM-dd HH:mm:ss | string There are two fields: booking_time and format_booking_time, can choose either one, but must ensure that the selected field has a value. The default time zone for the format_booking_time parameter should be the time zone of the pickup city |
Name | Description | Schema |
---|---|---|
passenger_name required |
Name of passenger | string |
passenger_phone required |
Mobile phone of passenger | string |
passenger_email optional |
Email address of passenger | string |
passenger_whats_app_account optional |
WhatsApp account of passenger | string |
passenger_wechat_account optional |
Wechat account of passenger | string |
Name | Description | Schema |
---|---|---|
quantity required |
Number of equipement/goods requested | integer (int32) |
code required |
service code | string |
price required |
price per unit | number (double) |
total_price required |
TotalPrice | number (double) |
Name | Description | Schema |
---|---|---|
transfer_fee required |
Base fee from Query Transfer Price | number (double) |
service_fee required |
Additional Services Fee | number (double) |
total_price required |
transfer_fee + service_fee | number (double) |
Name | Description | Schema |
---|---|---|
order_status required |
OrderStatus | enum OrderStatusEnum |
order_sn required |
Order number of Carzenplus | string |
booking_time required |
The booking time. unix timestamp | integer (int64) |
partner_order_sn required |
Partner order number. | string |
flight_code required |
The flight number including airline code | string |
transfer_type required |
The type of transfer. | enum Airport2Point Point2Airport Point2Point |
currency required |
TheCurrency code in ISO 4217 format. | string |
remark required |
Customer remark.. | string |
pick_up required |
Starting point information (address , name, latitude, longitude) | TransferPointInfo |
drop_off required |
End point information (address , name, latitude, longitude) | TransferPointInfo |
passenger_info required |
Number of passenger, include adults, children,infants | PassengerInfo |
luggage_info optional |
Requirements to luggage space to be supported by the vehicle | LuggageInfo |
passenger_contact_info required |
Passengers’ information. Information about “main” passenger is required | PassengerContactInfo |
transfer_services optional |
Support service | <BookingTransferServiceVO> arr |
transfer_vehicle optional |
Vehicle info | BookingVehicleVO |
provider optional |
Provider Info | PlatformProviderVO |
price_detail required |
Payment detail | BookingPriceDetailVO |
driver_info optional |
Driver information | BookingDriverVO |
Name | Description | Schema |
---|---|---|
service_code optional |
service code | string |
service_name optional |
service names | string |
price optional |
price per unit | number (double) |
quantity optional |
Quantity | integer (int32) |
Name | Description | Schema |
---|---|---|
plate_number optional |
Vehicle plate number | string |
brand_name optional |
Vehicle brand. e.g. Audi | string |
color optional |
Vehicle color | string |
model optional |
Vehicle model. e.g. A6 | string |
Name | Description | Schema |
---|---|---|
name optional |
Provider name | string |
logo_url optional |
Provider logo url | string |
Name | Description | Schema |
---|---|---|
phone optional |
Driver’s phone number | string |
name optional |
Driver’s name | string |
wechat optional |
Driver’s Wechat. | string |
whatsapp optional |
Driver’s Whatsapp etc. | string |
Name | Description | Schema |
---|---|---|
transfer_type required |
The type of transfer. | enum Airport2Point Point2Airport Point2Point |
price required |
Itinerary price. | number (double) |
currency required |
Currency code in ISO 4217 format. | string |
transfer_services required |
Transfer Services. | <TransferServiceVO> array |
transfer_vehicles required |
Vehicle information | <TransferVehicleVO> array |
provider optional |
Provider Info | PlatformProviderVO |
duration_in_seconds required |
The numeric duration, in seconds. | integer (int64) |
distance_in_meters required |
The numeric distance, in meters. | integer (int64) |
meeting_points optional |
Meeting point | <MeetingPointVO> array |
Name | Description | Schema |
---|---|---|
ticket required |
Book order ticket | string |
expire_time optional |
Ticket validity time, unix timespan | integer (int64) |
Name | Description | Schema |
---|---|---|
service_code optional |
service code | string |
service_name optional |
service names | string |
price optional |
price per unit | number (double) |
max_booking_count required |
max book count | integer (int32) |
description optional |
service descriptions | string |
Name | Description | Schema |
---|---|---|
transfer_ticket_info required |
Book order ticket | TransferTicket |
vehicle_name optional |
Vehicle model. e.g. A6 | string |
brand_name optional |
Vehicle brand. e.g. Audi | string |
vehicle_id optional |
Vehicle ID | integer (int64) |
max_passenger_quantity required |
Max seat count,without driver seat | integer (int32) |
max_luggage_quantity required |
Max luggage count | integer (int32) |
description optional |
Vehicle descriptions | string |
vehicle_icon optional |
Vehicle picture url | string |
price required |
equal to TransferFee | number (double) |
category required |
Vehicle category | enum ECONOMY STANDARD BUSINESS_CLASS FIRST_CLASS |
type required |
Vehicle type | enum SUV SEDAN VAN BUS LIMO |
free_waiting_time optional |
Free Waiting Time unit : minute | integer (int32) |
tags optional |
Vehicle Tag | <TransferTagVO> array |
Name | Description | Schema |
---|---|---|
authentication required |
Authentication parameter | TransferAuthenticationInfo |
order_sn required |
Order number of Carzenplus | string |
reason required |
Cancel reason Length : 0 - 200 |
string |
Name | Description | Schema |
---|---|---|
authentication required |
Authentication parameter | TransferAuthenticationInfo |
order_sn required |
Order number of Carzenplus | string |
Name | Description | Schema |
---|---|---|
currency required |
Currency code in ISO 4217 format | string |
cancel_time required |
Cancel Unix timespan,unit:Second | integer (int64) |
order_total_price required |
Order total price | number (double) |
cancel_loss_fee required |
Cancel loss fees | number (double) |
Name | Description | Schema |
---|---|---|
tag_name required |
Tag Name | string |
tag_value required |
Tag Value | string |
Name | Description | Schema |
---|---|---|
id optional |
Meeting point id | integer (int64) |
title optional |
Meeting point title | string |
description optional |
Meeting point title description | string |
picture optional |
Meeting point picture | string |
Value | Description |
---|---|
WAIT_CONFIRM | Booking Pending |
WAIT_DISPATCH | Booking Accepted |
WAIT_ASSIGN | Driver Pending |
WAIT_SERVICE | On Proceed |
DEPARTED | On the way to pickup |
ARRIVED | Arrived the pickup Point |
SERVING | Pick on board |
COMPLETED | Job completed |
CANCELLED | Booking Canceled |