Nhảy tới nội dung

8. Webhook

Luồng webhook được sử dụng để đồng bộ trạng thái mã vận đơn GHTK tới hệ thống của đối tác tích hợp APIs.

thông tin

Giả sử đơn hàng mã "S1.A1.17373471" (mã trên hệ thống khách hàng là "1234567") được cập nhật ""đã giao hàng thành công".

Giả sử callback link của đối tác là

https://doitac.example.com/updateShipment?hash=XXX

Data GHTK sẽ gửi tới callback link của đối tác theo nội dung

{
"partner_id" : "1234567",
"label_id": "S1.A1.17373471",
"status_id": 5,
"action_time": "2016-11-02T12:18:39+07:00",
"reason_code": "",
"reason": "",
"weight": 2.4,
"fee": 15000,
"pick_money": 100000,
"return_part_package": 0
}

Request gửi từ máy chủ của GHTK gọi sang hệ thống của đối tác

POST /updateShipment?hash=XXX HTTP/1.1
Host: doitac.example.com
Content-type: application/x-www-form-urlencoded

label_id=S1.A1.17373471&partner_id=1234567&action_time=2016-11-02T12:18:39+07:00&status_id=5&reason_code=&reason=&weight=2.4&fee=1500&return_part_package=0
thông tin

GHTK sử dụng response HTTP Status code để xác định là có gửi cập nhật cho đối tác thành công hay không.

Nếu nhận được response code 200, GHTK ghi nhận đã cập nhật thành công cho đối tác

HTTP/1.1 200 OK
warning

Nếu không nhận được response, hoặc code khác 200. GHTK sẽ gửi cập nhật lại một lần nữa

HTTP/1.1 500 Internal Server Error

Danh sách tham số cung cấp cho đối tác

Tham sốKiểu dữ liệuMô tả
label_idString- Mã đơn hàng của hệ thống GHTK
partner_idString- Mã đơn hàng thuộc hệ thống của đối tác
status_idInteger- Mã trạng thái đơn hàng
action_timeStringISO 8601 - Thời gian cập nhật trạng thái đơn hàng
reason_codeString- Mã lý do cập nhật
reasonString- Lý do chi tiết cập nhật
weightFloat- khối lượng đơn hàng tính theo kilogram
feeInteger- phí ship của đơn hàng (VNĐ)
return_part_packageInteger- Nếu bằng 1 là đơn giao hàng một phần

Trạng thái đơn hàng

Các trạng thái chuyển của đơn hàng trên hệ thống GHTK.

Tham sốMô tả
-1Hủy đơn hàng
1Chưa tiếp nhận
2Đã tiếp nhận
3Đã lấy hàng/Đã nhập kho
4Đã điều phối giao hàng/Đang giao hàng
5Đã giao hàng/Chưa đối soát
6Đã đối soát
7Không lấy được hàng
8Hoãn lấy hàng
9Không giao được hàng
10Delay giao hàng
11Đã đối soát công nợ trả hàng
12Đã điều phối lấy hàng/Đang lấy hàng
13Đơn hàng bồi hoàn
20Đang trả hàng (COD cầm hàng đi trả)
21Đã trả hàng (COD đã trả xong hàng)
123Shipper báo đã lấy hàng
127Shipper (nhân viên lấy/giao hàng) báo không lấy được hàng
128Shipper báo delay lấy hàng
45Shipper báo đã giao hàng
49Shipper báo không giao được giao hàng
410Shipper báo delay giao hàng
warning

Lưu ý: Các trạng thái cập nhật của Shipper 123, 127, 128, 45, 49, 410 chỉ mang tính chất thông báo thông tin, không phải trạng thái của đơn hàng trên GHTK.

Ví dụ Shipper có thể cập nhật 123 nhưng vì lý do khách quan (ví dụ: thao tác nhầm đơn) sau đó có thể cập nhật lại 127

Lý do chậm lấy hàng

Các lý do lấy hàng chậm hơn dữ kiến mặc định

Bảng mã reason_code cho trường hợp chậm lấy hàng (status_id = 8)

Mô tả
100Nhà cung cấp (NCC) hẹn lấy vào ca tiếp theo
101GHTK không liên lạc được với NCC
102NCC chưa có hàng
103NCC đổi địa chỉ
104NCC hẹn ngày lấy hàng
105GHTK quá tải, không lấy kịp
106Do điều kiện thời tiết, khách quan
107Lý do khác

Lý do không lấy được hàng

Mô tả
110Địa chỉ ngoài vùng phục vụ
111Hàng không nhận vận chuyển
112NCC báo hủy
113NCC hoãn/không liên lạc được 3 lần
114Lý do khác
115Đối tác hủy đơn qua API

Lý do chậm giao hàng

Mô tả
120GHTK quá tải, giao không kịp
121Người nhận hàng hẹn giao ca tiếp theo
122Không gọi được cho người nhận hàng
123Người nhận hàng hẹn ngày giao
124Người nhận hàng chuyển địa chỉ nhận mới
125Địa chỉ người nhận sai, cần NCC check lại
126Do điều kiện thời tiết, khách quan
127Lý do khác
128Đối tác hẹn thời gian giao hàng
129Không tìm thấy hàng
1200SĐT người nhận sai, cần NCC check lại

Lý do không giao được hàng

Mô tả
130Người nhận không đồng ý nhận sản phẩm
131Không liên lạc được với KH 3 lần
132KH hẹn giao lại quá 3 lần
133Shop báo hủy đơn hàng
134Lý do khác
135Đối tác hủy đơn qua API

Lý do delay trả hàng

Mô tả
140NCC hẹn trả ca sau
141Không liên lạc được với NCC
142NCC không có nhà
143NCC hẹn ngày trả
144Lý do khác