v2.order.cancel_order
POST /api/v2/order/cancel_order
Sử dụng API này để hủy một đơn hàng. Hành động này chỉ có thể thực hiện trước khi đơn hàng được giao cho đơn vị vận chuyển.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/order/cancel_order
Tham số chung
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | ID đối tác được cấp khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dấu thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token để truy cập API, dùng để xác định quyền của bạn với API. Có thể sử dụng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của shop trên Shopee. Bắt buộc cho hầu hết API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Chữ ký được tạo từ partner_id, đường dẫn API, timestamp, access_token, shop_id và partner_key thông qua thuật toán băm HMAC-SHA256. Chi tiết: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Tham số Request
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| order_sn | string | True | 201020SQQ5K2EP | Mã định danh duy nhất của đơn hàng trên Shopee. |
| cancel_reason | string | True | OUT_OF_STOCK | Lý do người bán muốn hủy đơn hàng. Các giá trị áp dụng: OUT_OF_STOCK CUSTOMER_REQUEST UNDELIVERABLE_AREA (Lưu ý: Chỉ áp dụng cho TW và MY) COD_NOT_SUPPORTED |
| item_list | object[] | False | Bắt buộc khi cancel_reason là OUT_OF_STOCK. | |
| item_id | int32 | True | 1680783 | ID của sản phẩm. |
| model_id | int64 | True | 327890123 | ID của phân loại thuộc cùng sản phẩm. |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | 2ead12d461c34e7c9275c42c2f70fa7d | Mã định danh cho yêu cầu API dùng để theo dõi lỗi. |
| error | string | common.error_auth | Loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. |
| message | string | Invalid access_token. | Chi tiết lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. |
| response | object | Thông tin chi tiết bạn đang truy vấn. | |
| update_time | timestamp | 1603184533 | Thời gian đơn hàng được cập nhật. |