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ính	Kiểu_DL	Mô_Tả_Chi_Tiết
type	String	Loại Cập Nhật. Ví dụ: update_status. Các giá trị có thể: - Trạng Thái: update_status. - Khối Lượng: update_weight.
code	String	Mã Đơn Hàng của SuperShip. Ví dụ: SGNS336484LM.883568271.
shortcode	String	Mã Đơn Ngắn của SuperShip. Ví dụ: 883568271.
soc	String	Mã Đơn Hàng của Người Gửi. Ví dụ: JLN-1805-1456.
phone	String	Số Điện Thoại của Người Nhận. Ví dụ: 01629091355.
address	String	Đị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.
amount	Integer	Số Tiền cần Thu Hộ. Ví dụ: 450000.
weight	Integer	Khối Lượng của Đơn Hàng. Ví dụ: 200.
fshipment	Integer	Cước Phí Giao Hàng. Ví dụ: 25000.
status	String	Mã Trạng Thái của Đơn Hàng. Ví dụ: 12.
status_name	String	Tên Trạng Thái của Đơn Hàng. Ví dụ: Đã Giao Hàng Toàn Bộ.
partial	String	Có Phải Đơn Đã Giao Hàng Một Phần? Ví dụ: 1.
barter	String	Có Phải Đơn Có Hàng Đổi Trả? Ví dụ: 1.
reason_code	String	Mã Lý Do. Ví dụ: 304.
reason_text	String	Chi Tiết Lý Do. Ví dụ: Không liên lạc được với Người Nhận.
created_at	String	- 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_at	String	- 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
pushed_at	String	- Thời Gian Đẩy Webhook. 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 '{
    "type": "update_status",
    "code": "SGNS336484LM.883568271",
    "shortcode": "883568271",
    "soc": "EG27533038-24",
    "name": "Anh Nam",
    "phone": "078882888",
    "address": "Đường Hữu Trí - Thị Trấn Tân Túc -Bình Chánh",
    "payer": "1",
    "amount": 230000,
    "weight": 800,
    "fshipment": 40000,
    "finsurance": 0,
    "status": "14",
    "status_name": "Hoãn Giao Hàng",
    "partial": "0",
    "barter": "0",
    "reason_code": "304",
    "reason_text": "Không liên lạc được với Người Nhận",
    "created_at": "2022-05-10T10:27:26+07:00",
    "updated_at": "2022-05-11T22:26:11+07:00",
    "pushed_at": "2022-05-11T22:26:11+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ính	Kiểu_DL	Mô_Tả_Chi_Tiết
url	String	URL nhận cập nhật thông tin đơn hàng từ SuperShip. Ví dụ: https://example.com/listen/supership.
created_at	String	- Thời Gian Tạo của Webhook. Ví dụ: 2018-07-03T17:18:29+07:00. - Định dạng ISO 8601
updated_at	String	- 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.

BẠN CÓ BIẾT

Đối với những đơn hàng thuộc Đối Tác Thương Mại Điện Tử, Đối Tác Phần Mềm Bán Hàng, Đối Tác Lớn khác thì Webhook Tự Động Áp Dụng đối với đơn hàng đã điền Mã Đối Tác khi Tạo Đơn Hàng qua Kênh API. Vì thế, không cần sử dụng API này để thêm Webhook thủ công cho từng Người Dùng.

MẸO & LƯU Ý

Để thay đổi Webhook hiện tại, bạn chỉ cần dùng API này với giá trị mới.
Các đơn hàng tạo sau thời điểm thay đổi Webhook thành công thì mới áp dụng Webhook mới.

Endpoint

post/v1/partner/webhooks/create

Request

Các Tham Số

Thuộc_Tính	Bắt_Buộc	Kiểu_DL	Mô_Tả_Chi_Tiết
url	Có	String	URL 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ính	Kiểu_DL	Mô_Tả_Chi_Tiết
url	String	URL nhận cập nhật thông tin đơn hàng từ SuperShip. Ví dụ: https://example.com/listen/supership.
created_at	String	- Thời Gian Tạo của Webhook. Ví dụ: 2018-07-03T17:18:29+07:00. - Định dạng ISO 8601
updated_at	String	- 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"
  }
}

# Webhooks

# Cập Nhật Mẫu

# Request

# Các Tham Số

# Ví Dụ

# Response

# Lấy Thông Tin Webhook

# Endpoint

# Request

# Ví Dụ

# Response

# Kết Quả Trả Về

# Ví Dụ

# Tạo Webhook

# Endpoint

# Request

# Các Tham Số

# Ví dụ

# Response

# Kết Quả Trả Về

# Ví dụ

Webhooks

Cập Nhật Mẫu

Request

Các Tham Số

Ví Dụ

Response

Lấy Thông Tin Webhook

Endpoint

Request

Ví Dụ

Response

Kết Quả Trả Về

Ví Dụ

Tạo Webhook

Endpoint

Request

Các Tham Số

Ví dụ

Response

Kết Quả Trả Về

Ví dụ