Webhook Reference

Trang này mô tả cấu trúc payload của webhook event cho đơn hoả tốc. Xem hướng dẫn cài đặt và xác thực webhook tại Webhooks.

Payload sự kiện

Cập nhật trạng thái vận đơn

{
  "is_ondemand_shipment": true,
  "gcode": "GS6ZE234V6",
  "code": "GAPBLXAE",
  "order_id": "SML-003749",
  "fee": 35650,
  "cod": 0,
  "status": 901,
  "message": "Chờ shipper qua lấy hàng",
  "description": "Chờ shipper qua lấy hàng",
  "tracking_url": "https://express.grab.com/track/exampleCode",
  "error": null,
  "error_txt": null,
  "cancel_at": null,
  "pickup_at": "2025-05-13T09:15:00+07:00",
  "delivery_at": null,
  "shipper_accept_at": "2025-05-13T08:45:00+07:00",
  "completed_at": null,
  "returned_at": null,
  "paths": [
    {
      "uuid": "GS123123",
      "status": "Chờ lấy hàng",
      "tracking_number": "GHN12345678",
      "tracking_url": "https://tracking.example.com/GHN12345678",
      "completed_at": null,
      "failed_at": null,
      "returned_at": null,
      "fail_note": null
    },
    {
      "uuid": "GS234234",
      "status": "Đang giao",
      "tracking_number": "GHN12345679",
      "tracking_url": "https://tracking.example.com/GHN12345679",
      "completed_at": null,
      "failed_at": null,
      "returned_at": null,
      "fail_note": null
    }
  ]
}

Trong đó:

• is_ondemand_shipment: Đánh dấu đây là đơn hoả tốc
• gcode: Mã đơn của Goship
• code: Mã đơn của hãng vận chuyển
• order_id: Mã vận đơn của bạn
• fee: Phí vận chuyển (đơn vị: VNĐ)
• cod: Giá tiền thu hộ từ người nhận (Cash on Delivery)
• status: Mã trạng thái vận đơn
• message: Trạng thái vận đơn (hiển thị dạng chữ, ví dụ: "Chờ shipper qua lấy hàng")
• description: Mô tả chi tiết trạng thái vận đơn (có thể giống hoặc khác message)
• tracking_url: Đường dẫn theo dõi vận đơn trên trang của hãng vận chuyển
• error: Mã lỗi nếu có lỗi xảy ra trong quá trình tạo đơn
• error_txt: Mô tả lỗi nếu có lỗi xảy ra trong quá trình tạo đơn
• cancel_at: Thời điểm đơn hàng bị huỷ (nếu có), định dạng ISO 8601
• pickup_at: Thời điểm shipper đến lấy hàng (nếu có)
• delivery_at: Thời điểm shipper bắt đầu giao hàng (nếu có)
• shipper_accept_at: Thời điểm shipper nhận đơn từ hệ thống
• completed_at: Thời điểm đơn giao thành công
• returned_at: Thời điểm đơn bị hoàn trả về (nếu có)
• paths: Danh sách các điểm giao/nhận trong hành trình của đơn hàng, mỗi phần tử gồm:
  • uuid: Mã định danh điểm giao/nhận
  • status: Trạng thái hiện tại tại điểm đó (dạng số)
  • message: Trạng thái hiện tại tại điểm đó (dạng chữ)
  • kind: Loại điểm giao/nhận
  • tracking_number: Mã vận đơn tại điểm đó (nếu có)
  • tracking_url: Đường dẫn theo dõi tại điểm đó
  • completed_at: Thời điểm hoàn thành tại điểm đó (nếu có)
  • failed_at: Thời điểm thất bại tại điểm đó (nếu có)
  • returned_at: Thời điểm bị hoàn trả tại điểm đó (nếu có)
  • fail_note: Ghi chú lý do thất bại (nếu có)

Khi bạn nhận được các thông tin này, bạn có thể cập nhật lại thông tin vận đơn cho chính xác.

Xem thêm danh sách trạng thái vận đơn

Webhook API