API ReferenceBookings
Xem chuyến
GET
Nên dùng webhook thay vì gọi liên tục. Nếu cần gọi định kỳ, tối đa 1 lần mỗi 15 giây cho mỗi chuyến.
ApiKeyAuthheader
Authorization<token>Authorization: ApiKey <key>. Key sandbox bắt đầu bằng gc_test_, production bằng gc_live_.
Key chỉ hiện một lần lúc tạo. Không dùng key trong app di động hay trình duyệt.
booking_id*stringOK
application/json- response
success*booleandata*curl -X GET 'https://api-stag.gocheap.vn/open-api/v1/bookings/string'Example Response
{ "success": true, "data": { "booking_id": "string", "partner_reference_id": "string", "service": "thue-tai-xe", "status": "searching", "pick_up": { "place_id": "string", "name": "string", "address": "string", "lat": 0.1, "lng": 0.1 }, "destination": { "place_id": "string", "name": "string", "address": "string", "lat": 0.1, "lng": 0.1 }, "pick_up_time": "2019-08-24T14:15:22Z", "ways": "one_way", "distance_m": 0, "price": 0, "final_price": 0, "currency": "VND", "payment_method": "cash", "customer": { "name": "string", "phone": "string", "external_id": "string" }, "driver": { "name": "string", "phone": "string", "rating": 0, "eta_s": 0, "location": { "lat": 0.1, "lng": 0.1, "updated_at": "2019-08-24T14:15:22Z" } }, "cancellation": { "cancelled_by": "client", "reason": "string", "cancelled_at": "2019-08-24T14:15:22Z" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}Tạo chuyến POST
Tạo chuyến từ báo giá còn hiệu lực. Chuyến được phát cho tài xế ngay (sandbox thì không). Gửi lại cùng `Idempotency-Key` trong 24 giờ sẽ nhận lại đúng chuyến đã tạo, không tạo thêm.
Huỷ chuyến POST
Huỷ được khi chuyến ở `searching`, `driver_assigned` hoặc `driver_arriving`. Không huỷ được khi đã `in_progress`.