Webhooks

Các API về webhook cho phép bạn tạo, xem, cập nhật và xóa một hay nhiều webhook.

Cập Nhật Mẫu

Mỗi khi có sự thay đổi Trạng Thái Đơn Hàng ở Hệ Thống SuperShip, chúng tôi sẽ gửi một cập nhật sang hệ thống của Đối Tác thông qua Callback URL mà Đối Tác đã thiếp lập trước đó.

Request

Các Tham Số

Thuộc_TínhKiểu_DLMô_Tả_Chi_Tiết
codeStringMã Đơn Hàng của SuperShip. Ví dụ: S634172SGNT.0000001.
socStringMã Đơn Hàng của Người Gửi. Ví dụ: JLN-1805-1456.
phoneStringSố Điện Thoại của Người Nhận. Ví dụ: 01629091355.
addressStringĐịa Chỉ của Người Nhận. Ví dụ: 47 Huỳnh Văn Bánh, Phường 5, Quận Phú Nhuận, Thành phố Hồ Chí Minh.
amountIntegerSố Tiền cần Thu Hộ. Ví dụ: 450000.
weightIntegerKhối Lượng của Đơn Hàng. Ví dụ: 200.
fshipmentIntegerCước Phí Giao Hàng. Ví dụ: 25000.
statusStringMã Trạng Thái của Đơn Hàng. Ví dụ: 12.
status_nameStringTên Trạng Thái của Đơn Hàng. Ví dụ: Đã Giao Hàng Toàn Bộ.
created_atString- Thời Gian Tạo của Đơn Hàng. Ví dụ: 2018-07-03T17:18:29+07:00.
- Định dạng ISO 8601
updated_atString- Thời Gian Cập Nhật của Đơn Hàng. Ví dụ: 2018-07-03T17:18:29+07:00.
- Định dạng ISO 8601

Ví Dụ

curl --request POST \
  --url https://example.com/listen/supership \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "S634172SGNT.0000001",
    "soc": "JLN-1805-1456",
    "phone": "01629091355",
    "address": "47 Huỳnh Văn Bánh",
    "weight": 200,
    "fshipment": 20000,
    "status": "11",
    "status_name": "Đã Giao Hàng Toàn Bộ",
    "updated_at": "2018-06-10T08:00:00+07:00"
}'

Response

SuperShip dựa vào HTTP Response Status Code để xác định xem lần gửi cập nhật Đơn Hàng sang Hệ Thống Đối Tác. Nếu kết quả là 200 thì SuperShip xác định đó là cập nhật thành công.

Lấy Thông Tin Webhook

API này cho phép bạn lấy thông tin tất cả các webhook hiện có.

Endpoint

get/v1/partner/webhooks

Request

Ví Dụ

curl --request GET \
  --url https://api.mysupership.vn/v1/partner/webhooks \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <Access-Token>'

Response

Kết Quả Trả Về

Thuộc_TínhKiểu_DLMô_Tả_Chi_Tiết
urlStringURL nhận cập nhật thông tin đơn hàng từ SuperShip. Ví dụ: https://example.com/listen/supership.
created_atString- Thời Gian Tạo của Webhook. Ví dụ: 2018-07-03T17:18:29+07:00.
- Định dạng ISO 8601
updated_atString- Thời Gian Cập Nhật của Webhook. Ví dụ: 2018-07-03T17:18:29+07:00.
- Định dạng ISO 8601

Ví Dụ

{
  "status": "Success",
  "results": {
    "url": "https://example.com/listen/supership",
    "created_at": "2017-09-29 01:52:09",
    "updated_at": "2017-09-29 02:08:28"
  }
}

Tạo Webhook

API này cho phép bạn tạo một webhook mới.

Endpoint

post/v1/partner/webhooks/create

Request

Các Tham Số

Thuộc_TínhBắt_BuộcKiểu_DLMô_Tả_Chi_Tiết
urlStringURL mà đối tác muốn nhận cập nhật thông tin đơn hàng từ SuperShip. Ví dụ: https://example.com/listen/supership.

Ví dụ

curl --request POST \
  --url https://api.mysupership.vn/v1/partner/webhooks/create \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <Access-Token>' \
  --header 'Content-Type: application/json' \
  --data '{
	"url": "https://example.com/listen/supership"
}'

Response

Kết Quả Trả Về

Thuộc_TínhKiểu_DLMô_Tả_Chi_Tiết
urlStringURL nhận cập nhật thông tin đơn hàng từ SuperShip. Ví dụ: https://example.com/listen/supership.
created_atString- Thời Gian Tạo của Webhook. Ví dụ: 2018-07-03T17:18:29+07:00.
- Định dạng ISO 8601
updated_atString- Thời Gian Cập Nhật của Webhook. Ví dụ: 2018-07-03T17:18:29+07:00.
- Định dạng ISO 8601

Ví dụ

{
  "status": "Success",
  "results": {
    "url": "https://example.com/listen/supership",
    "created_at": "2017-09-29 01:52:09",
    "updated_at": "2017-10-13 00:09:18"
  }
}
Cập Nhật Lần Cuối: 2018-7-5 06:08:43