5. API lấy trạng thái đơn hàng
API dùng để lấy trạng thái hiện tại của 1 mã vận đơn GHTK
Mô tả
Sau khi đơn hàng được gửi tới hệ thống của Giaohangtietkiem. Khách hàng có thể kiểm tra trạng thái các đơn hàng dựa vào mã đơn hàng.
Request
Đường dẫn
GET /services/shipment/v2/{TRACKING_ORDER}
Headers
Token: {API_TOKEN}
X-Client-Source: {PARTNER_CODE}
Tham số
Tham số | Bắt buộc | Mô tả |
---|---|---|
TRACKING_ORDER | Có | Mã đơn hàng GHTK hoặc mã Đối tác được truyền qua ở trường order.id ở API đăng đơn |
Code
- HTTP
- CURL
- PHP
GET /services/shipment/v2/S1.A1.17373471 HTTP/1.1
Token: {API_TOKEN}
X-Client-Source: {PARTNER_CODE}
curl -X GET -H "Token: APITokenSample-ca441e70288cB0515F310742" \
-H "Token: {API_TOKEN}" \
-H "X-Client-Source: {PARTNER_CODE}" \
"https://services.giaohangtietkiem.vn/services/shipment/v2/{TRACKING_ORDER}"
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://services.giaohangtietkiem.vn/services/shipment/v2/S1.A1.17373471",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_HTTPHEADER => array(
"Token: APITokenSample-ca441e70288cB0515F310742",
),
));
$response = curl_exec($curl);
curl_close($curl);
echo 'Response: ' . $response;
?>
Phản hồi
Kết quả trả về
Hệ thống sẽ trả về kết quả dưới dạng JSON. Kết quả trả về được mô tả như sau:
Tham số | Mô tả |
---|---|
label_id | String - Mã đơn hàng của hệ thống GHTK |
partner_id | String - Mã đơn hàng thuộc hệ thống của đối tác |
status | String - Mã trạng thái đơn hàng. Tham khảo bảng mã trạng thái đơn hàng. |
status_text | String - Trạng thái đơn hàng. |
created | String - Thời gian tạo đơn hàng, định dạng YY-MM-DD hh:mm:ss |
modified | String - Thời gian cuối cùng cập nhật đơn hàng, định dạng YY-MM-DD hh:mm:ss |
message | String - Ghi chú của đơn hàng |
pick_date | String - Ngày hẹn lấy hàng của đơn hàng nếu có, nếu đơn hàng đã được lấy thành công thì là ngày lấy hàng |
deliver_date | String - Ngày hẹn giao đơn hàng nếu có, nếu đơn hàng đã được giao hàng thì là ngày giao hàng thành công |
customer_fullname | String - Họ tên người nhận hàng |
customer_tel | String - Số điện thoại người nhận hàng |
address | String - Địa chỉ người nhận hàng |
storage_day | Integer - Số ngày giữ đơn hàng tại kho GHTK trước khi trả hàng |
ship_money | Integer - Phí giao hàng |
insurance | Integer - Phí bảo hiểm |
value | Integer - Giá trị đóng bảo hiểm - căn cứ để bồi thường cho người gửi khi có sự cố xảy ra |
weight | Integer - Khối lượng đơn hàng tính theo gram |
pick_money | Integer - Số tiền CoD |
is_freeship | Integer - Freeship cho người nhận hàng |
Thành công
{
"success": true,
"message": "",
"order": {
"label_id": "S1.A1.17373471",
"partner_id": "1234567",
"status": "1",
"status_text": "Chưa tiếp nhận",
"created": "2016-10-31 22:32:08",
"modified": "2016-10-31 22:32:08",
"message": "Không giao hàng 1 phần",
"pick_date": "2017-09-13",
"deliver_date": "2017-09-14",
"customer_fullname": "Vân Nguyễn",
"customer_tel": "0911222333",
"address": "123 nguyễn chí thanh Quận 1, TP Hồ Chí Minh",
"storage_day": "3",
"ship_money": "16500",
"insurance": "16500",
"value": "3000000",
"weight": "300",
"pick_money": 47000,
"is_freeship": "1"
}
}