v2.logistics.get_booking_shipping_document_parameter
POST /api/v2/logistics/get_booking_shipping_document_parameter
Sử dụng API này để lấy các loại shipping_document_type có thể chọn và loại shipping_document_type được gợi ý.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/logistics/get_booking_shipping_document_parameter
Tham số chung
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được cấp khi đăng ký thành công. Bắt buộc cho mọi yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để xác định thời điểm của yêu cầu. Bắt buộc cho mọi 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 truy cập của bạn. 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 cửa hàng trên Shopee. Bắt buộc cho hầu hết các 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 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 |
|---|---|---|---|---|
| booking_list | object[] | True | Danh sách các booking cần lấy. Giới hạn [1,50] | |
| booking_sn | string | True | 201201E81SYYKE | Mã định danh duy nhất của booking trên Shopee. |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | a8e1b94f51d64540bf5762abe7783073 | Mã định danh của yêu cầu API để theo dõi lỗi. |
| error | string | common.error_auth | Cho biết 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. | Cho biết chi tiết lỗi nếu có lỗi xảy ra. Để trống nếu không có lỗi. |
| warning | object[] | Cho biết thông báo cảnh báo bạn cần lưu ý. | |
| booking_sn | string | 201201E81SYYKE | Mã định danh duy nhất của booking trên Shopee. |
| response | object | Thông tin chi tiết bạn đang truy vấn. | |
| result_list | object[] | Danh sách kết quả. | |
| booking_sn | string | 201201E81SYYKE | Mã định danh duy nhất của booking trên Shopee. |
| suggest_shipping_document_type | string | THERMAL_AIR_WAYBILL | Loại tài liệu vận chuyển Shopee gợi ý. Nếu bạn không chọn loại nào, Shopee sẽ dùng loại này làm mặc định. |
| selectable_shipping_document_type | string[] | ["THERMAL_AIR_WAYBILL"] | Các loại tài liệu vận chuyển có thể chọn cho booking này. |
| fail_error | string | logistics.booking_not_exist | Cho biết loại lỗi nếu một phần tử gặp lỗi. |
| fail_message | string | The booking_sn 201201V81SYYDG you provided is not exist. | Cho biết chi tiết lỗi nếu một phần tử gặp lỗi. |