Chuyển tới nội dung chính

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

NameTypeSampleDescription
partner_idint1Partner 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.
timestamptimestamp1610000000Dù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_tokenstringc09222e3fc40ffb25fc947f738b1abf1Token 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_idint600000Mã đị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.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Chữ 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

NameTypeRequiredSampleDescription
booking_sn_liststringTrue201214JAJXU6G7,201214JASXYXY6Tậ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_fieldsstringFalsetotal_amountCá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

NameTypeSampleDescription
request_idstringa8e1b94f51d64540bf5762abe7783073Mã định danh của yêu cầu API dùng để theo dõi lỗi.
errorstringcommon.error_authCho biết loại lỗi nếu xảy ra. Trống nếu không có lỗi.
messagestringInvalid access_token.Cho biết chi tiết lỗi nếu xảy ra. Trống nếu không có lỗi.
responseobjectThông tin chi tiết bạn đang truy vấn.
booking_listobject[]Danh sách các booking.
booking_snstring201214JASXYXY6Trả về mặc định. Mã định danh duy nhất của Shopee cho một booking.
order_snstring201218V2Y6E59MMã định danh duy nhất của Shopee cho một đơn hàng. Chỉ trả về nếu booking_status là MATCHED.
regionstringMYTrả về mặc định. Mã hai chữ số đại diện cho khu vực nơi booking được tạo.
booking_statusstringCANCELLEDReturn by default. Enumerated type that defines the current status of the booking. Available value: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED
match_statusstringMATCH_PENDINGMATCH_PENDING/MATCH_SUCCESSFUL/MATCH_FAILED
shipping_carrierstringStandard DeliveryĐơn vị cung cấp dịch vụ logistics sẽ giao hàng đặt chỗ.
create_timetimestamp1607930885Trả về mặc định. Dấu thời gian cho biết ngày giờ tạo booking.
update_timetimestamp1608134691Trả 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_dateint641608103685Trả về mặc định. Hạn chót để gửi kiện hàng đi.
recipient_addressobjectĐối tượng này chứa thông tin chi tiết về địa chỉ người nhận.
namestringMaxTên người nhận tại địa chỉ đó.
phonestring3828203Số điện thoại người nhận được nhập khi tạo booking.
townstringSaraThị 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.
districtstringDadaQuậ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.
citystringAsajayaThà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.
statestringSarawakTỉ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.
regionstringMYMã hai chữ số đại diện cho khu vực của người nhận.
zipcodestring40009Mã bưu chính của người nhận.
full_addressstringC-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_listobject[]Đố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_idint642600144043Mã định danh duy nhất của Shopee cho một sản phẩm.
item_namestringbackpackTên sản phẩm.
item_skustringskuSKU 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_idint640ID của biến thể thuộc cùng một sản phẩm.
model_namestringTê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_skustringSKU 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_purchasedint641Số 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.
weightfloat12.0Trọng lượng của sản phẩm.
product_location_idstringID 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_infoobjectThông tin hình ảnh của sản phẩm.
image_urlstringURL 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ế.
dropshipperstringChỉ dành cho booking Indonesia. Tên nhà dropshipper.
dropshipper_phonestringSố điện thoại của nhà dropshipper, có thể trống.
cancel_bystringsystemCó thể là buyer (người mua), seller (người bán), system (hệ thống) hoặc Ops.
cancel_reasonstringBACKEND_LOGISTICS_NOT_STARTEDDù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_flagstringfulfilled_by_shopeeDù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_timetimestamp0Dấu thời gian khi việc lấy hàng hoàn tất.
warningstringstring[]Cho biết thông báo cảnh báo bạn cần chú ý.