Webhook

Trả về trạng thái bưu gửi thông qua api ngay khi có trạng thái mới nhất.

Để cấu hình webhook, người dùng đăng nhập vào hệ thống, tại menu bên trái.

Cấu hình > Webhook > Click Tạo webhook

Header / Body json

Header

Header

Content-Type : application/json
ems-transaction : "1234567890"

ems-transaction là 1 chuỗi ký tự ngẫu nhiên duy nhất ứng với mỗi trạng thái bưu gửi

Body json

Body json

{
    "tracking_code": "EJ012345678VN",
    "order_code": "ODR356",
    "status_code": 4,
    "status_name": "Đang vận chuyển",
    "note": "Đã đóng chuyến thư đi",
    "locate": "890100 - KTC1 Vĩnh Long (ÐT:02703834180)",
    "datetime": "28/08/2019 07:54:50",
    "total_weight": 240,
    "money_collect": 210000,
    "total_fee": 34000
}

*Note: 
    datetime: thời gian cập nhật trạng thái.
    Chú ý sắp xếp trạng thái nhận về theo trường "datetime".
    Trạng thái có datetime mới nhất sẽ là trạng thái cuối cùng.

Description

Parameter	Description
tracking_code	Mã bưu gửi
order_code	Mã đơn hàng (Nếu có)
status_code	Mã trạng thái
status_name	Tên trạng thái
note	Ghi chú
locate	Vị trí bưu gửi
datetime	Thời gian cập nhật trạng thái
total_weight	Khối lượng bưu gửi
money_collect	Số tiền thu hộ
total_fee	Tổng cước (Tạm tính)

Response demo

Success response

{
 "code" : "success",
 "transaction" : "1234567890"
}

Error response

{
 "code" : "error",
 "transaction" : "1234567890"
}

Api callback phải có định dạng response giống với response demo và có method là POST

Developer xắp sếp dữ liệu webhook nhận về theo param "datetime" trong body json nhận được trước khi hiển thị dữ liệu để tránh hiển thị sai trạng thái.

transaction lấy tại ems-transaction trên header