GOCheap Developers
API ReferenceBookings

Danh sách chuyến

GET
/bookings

Chỉ trả chuyến do chính tài khoản đối tác tạo, mới nhất trước.

Authorization

ApiKeyAuth
headerAuthorization<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.

Query Parameters

partner_reference_id?string
status?string
  • searching: đang tìm tài xế
  • driver_assigned: tài xế đã nhận chuyến
  • driver_arriving: tài xế đang đến điểm đón
  • in_progress: đã đón khách, đang di chuyển
  • completed: hoàn thành
  • cancelled: đã huỷ (xem cancellation)
Value in"searching""driver_assigned""driver_arriving""in_progress""completed""cancelled"
created_from?string
Formatdate-time
created_to?string
Formatdate-time
page?integer
Range1 <= value
Default1
limit?integer
Range1 <= value <= 100
Default20

Response Body

OK

application/json
  1. response
success*boolean
data*array<>
pagination*
Example Request
curl -X GET 'https://api-stag.gocheap.vn/open-api/v1/bookings'
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"    }  ],  "pagination": {    "page": 0,    "limit": 0,    "total": 0  }}

Báo giá POST

Tính giá theo bảng giá GOCheap (dịch vụ, khu vực, quãng đường, khung giờ). Báo giá có hiệu lực 10 phút; tạo chuyến bằng `quote_id` sẽ giữ đúng giá này.

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.