v2.order.get_booking_detail
GET /api/v2/order/get_booking_detail
Sử dụng API này để lấy chi tiết booking.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/order/get_booking_detail
Tham số chung
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được gán 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ùng để chỉ định thời điểm gửi 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 dùng để truy cập API, xác định quyền của bạn. Có thể 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 Shopee cho một cửa hàng. Tham số 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 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_sn_list | string | True | 201214JAJXU6G7,201214JASXYXY6 | Tập hợp các booking_sn. Nếu có nhiều booking_sn, dùng dấu phẩy tiếng Anh để nối. Giới hạn [1,50] |
| response_optional_fields | string | False | total_amount | Các trường phản hồi bạn muốn lấy. Vui lòng chọn từ các tham số phản hồi bên dưới và phân tách bằng dấu phẩy. |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | a8e1b94f51d64540bf5762abe7783073 | Mã định danh của yêu cầu API dùng để theo dõi lỗi. |
| error | string | common.error_auth | Cho biết loại lỗi nếu 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 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. | |
| booking_list | object[] | Danh sách các booking. | |
| booking_sn | string | 201214JASXYXY6 | Trả về mặc định. Mã định danh duy nhất của Shopee cho một booking. |
| order_sn | string | 201218V2Y6E59M | Mã định danh duy nhất của Shopee cho một đơn hàng. Chỉ trả về nếu booking_status là MATCHED. |
| region | string | MY | Trả về mặc định. Mã hai chữ số đại diện cho khu vực nơi booking được tạo. |
| booking_status | string | CANCELLED | Return by default. Enumerated type that defines the current status of the booking. Available value: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED |
| match_status | string | MATCH_PENDING | MATCH_PENDING/MATCH_SUCCESSFUL/MATCH_FAILED |
| shipping_carrier | string | Standard Delivery | Đơn vị cung cấp dịch vụ logistics sẽ giao hàng đặt chỗ. |
| create_time | timestamp | 1607930885 | Trả về mặc định. Dấu thời gian cho biết ngày giờ tạo booking. |
| update_time | timestamp | 1608134691 | Trả về mặc định. Dấu thời gian cho biết lần cuối có thay đổi giá trị trong booking, ví dụ trạng thái đổi từ 'Processed' sang 'Shipped'. |
| ship_by_date | int64 | 1608103685 | Trả về mặc định. Hạn chót để gửi kiện hàng đi. |
| recipient_address | object | Đối tượng này chứa thông tin chi tiết về địa chỉ người nhận. | |
| name | string | Max | Tên người nhận tại địa chỉ đó. |
| phone | string | 3828203 | Số điện thoại người nhận được nhập khi tạo booking. |
| town | string | Sara | Thị trấn trong địa chỉ người nhận. Có hay không tùy thuộc vào khu vực và/hoặc quốc gia. |
| district | string | Dada | Quận/huyện trong địa chỉ người nhận. Có hay không tùy thuộc vào khu vực và/hoặc quốc gia. |
| city | string | Asajaya | Thành phố trong địa chỉ người nhận. Có hay không tùy thuộc vào khu vực và/hoặc quốc gia. |
| state | string | Sarawak | Tỉnh/thành phố trong địa chỉ người nhận. Có hay không tùy thuộc vào khu vực và/hoặc quốc gia. |
| region | string | MY | Mã hai chữ số đại diện cho khu vực của người nhận. |
| zipcode | string | 40009 | Mã bưu chính của người nhận. |
| full_address | string | C-15-14 BLOK C JALAN 30/146, Asajaya, 40009, Sarawak | Địa chỉ đầy đủ của người nhận, bao gồm quốc gia, tỉnh/thành, đường phố, v.v. |
| item_list | object[] | Đối tượng này chứa thông tin chi tiết cho kết quả của lần gọi API này. | |
| item_id | int64 | 2600144043 | Mã định danh duy nhất của Shopee cho một sản phẩm. |
| item_name | string | backpack | Tên sản phẩm. |
| item_sku | string | sku | SKU sản phẩm (stock keeping unit) là mã định danh do người bán xác định, đôi khi gọi là SKU cha. SKU sản phẩm có thể được gán cho một sản phẩm trong danh sách Shopee. |
| model_id | int64 | 0 | ID của biến thể thuộc cùng một sản phẩm. |
| model_name | string | Tên biến thể thuộc cùng một sản phẩm. Người bán có thể cung cấp nhiều biến thể. Mỗi kết hợp màu sắc và kích thước là một biến thể riêng biệt với số lượng và giá có thể khác nhau. | |
| model_sku | string | SKU biến thể (stock keeping unit) là mã định danh do người bán xác định, chỉ dành cho mục đích sử dụng nội bộ. Nhiều người bán gán SKU theo loại, kích thước và màu sắc, đại diện cho các biến thể trong danh sách Shopee. | |
| model_quantity_purchased | int64 | 1 | Số lượng sản phẩm giống nhau từ một danh sách/sản phẩm trong cùng một booking. |
| weight | float | 12.0 | Trọng lượng của sản phẩm. |
| product_location_id | string | ID kho thực hiện của các sản phẩm trong booking. (Chỉ dành cho người bán đa kho) | |
| image_info | object | Thông tin hình ảnh của sản phẩm. | |
| image_url | string | URL hình ảnh của sản phẩm. Mặc định là hình ảnh biến thể; nếu biến thể không có hình ảnh, sẽ dùng hình ảnh chính thay thế. | |
| dropshipper | string | Chỉ dành cho booking Indonesia. Tên nhà dropshipper. | |
| dropshipper_phone | string | Số điện thoại của nhà dropshipper, có thể trống. | |
| cancel_by | string | system | Có thể là buyer (người mua), seller (người bán), system (hệ thống) hoặc Ops. |
| cancel_reason | string | BACKEND_LOGISTICS_NOT_STARTED | Dùng trường này để lấy lý do hủy của người mua, người bán và hệ thống. |
| fulfillment_flag | string | fulfilled_by_shopee | Dùng trường này để cho biết booking được thực hiện bởi Shopee hay người bán. Giá trị áp dụng: fulfilled_by_shopee, fulfilled_by_cb_seller, fulfilled_by_local_seller. |
| pickup_done_time | timestamp | 0 | Dấu thời gian khi việc lấy hàng hoàn tất. |
| warning | string | string[] | Cho biết thông báo cảnh báo bạn cần chú ý. |