4. API 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

GET /services/shipment/v2/S1.A1.17373471 HTTP/1.1
Token: {API_TOKEN}
X-Client-Source: {PARTNER_CODE}

CURL

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

<?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í khai giá
value	Integer - Giá trị đóng khai giá - 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
ext_fees	Array Object - Danh sách các loại phụ phí. Xem chi tiết ở bảng dưới

Chi tiết từng phần tử trong ext_fees:

Tham số	Mô tả
type	String - Loại phụ phí. Xem danh sách các giá trị ở bảng dưới
title	String - Tên hiển thị của phụ phí
amount	Integer - Số tiền phụ phí

Danh sách các phụ phí:

type	title
food_fee	Phụ phí hàng nông sản/thực phẩm khô
fragile_fee	Phụ phí đơn hàng dễ vỡ
reinforced_fee	Phụ phí đơn hàng gia cố
fullbox_fee	Phụ phí đơn hàng nguyên hộp
try_on_fee	Phụ phí thử hàng
document_fee	Phí thư tín
short_exp_fee	Phí xăng dầu
xfast_fee	Phí xfast
bbs_return_fee	Phí trả hàng BBS
bbs_loading_1_low_fee	Phí bốc xếp tầng trệt (chiều 1)
bbs_loading_1_high_fee	Phí bốc xếp tầng lầu (chiều 1)
bbs_loading_2_low_fee	Phí bốc xếp tầng trệt (chiều 2)
bbs_supporter_fee	Phí hỗ trợ bốc xếp BBS
bbs_waiting_fee	Phí chờ trên mỗi điểm giao
deliver_to_door_fee	Phí giao hàng tận cửa
plant_fee	Phụ phí hàng cây cối
otp_verification_fee	Phí OTP xác nhận nhận hàng
check_pickup_fee	Phí kiểm hàng trước khi lấy
co_check_fee	Phí thử hàng/đồng kiểm
change_return_add_fee	Phí sửa địa chỉ trả hàng
re_delivery_fee	Phí giao lại
change_address_fee	Phí đổi địa chỉ giao
gam_solution_fee	Phí từ dịch vụ Gam Solution

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",
        "ext_fees": [
            {
                "type": "fragile_fee",
                "title": "Phụ phí dễ vỡ",
                "amount": 5000
            }
        ]
    }
}