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

v2.order.get_order_detail

GET /api/v2/order/get_order_detail

Sử dụng API này để lấy chi tiết đơn hàng.

Đường dẫn Endpoint

URL: https://partner.shopeemobile.com/api/v2/order/get_order_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
order_sn_liststringTrue201214JAJXU6G7,201214JASXYXY6Tập hợp các order_sn. Nếu có nhiều order_sn, dùng dấu phẩy tiếng Anh để nối. Giới hạn [1,50]
request_order_status_pendingbooleanFalsetrueTham số tương thích trong giai đoạn chuyển đổi. Gửi True để API hỗ trợ trạng thái PENDING và trả về pending_terms; gửi False hoặc không gửi để giữ logic cũ
response_optional_fieldsstringFalsetotal_amountCác trường phản hồi bạn muốn lấy. Chọn từ các tham số phản hồi bên dưới. Nếu nhập trường object, tất cả tham số trong đó sẽ được tự động trả về. Nếu muốn nhiều trường, dùng dấu phẩy tiếng Anh để nối. Available values: buyer_user_id,buyer_username,estimated_shipping_fee,recipient_address,actual_shipping_fee ,goods_to_declare,note,note_update_time,item_list,pay_time,dropshipper, dropshipper_phone,split_up,buyer_cancel_reason,cancel_by,cancel_reason,actual_shipping_fee_confirmed,buyer_cpf_id,fulfillment_flag,pickup_done_time,package_list,shipping_carrier,payment_method,total_amount,buyer_username,invoice_data,order_chargeable_weight_gram,return_request_due_date,edt,payment_info,international_label

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.
order_listobject[]Danh sách đơn hàng.
order_snstring2404098R48U37HTrả về mặc định. Mã định danh duy nhất của Shopee cho một đơn hàng.
regionstringVNTrả về mặc định. Mã hai chữ số đại diện cho khu vực nơi đơn hàng được đặt.
currencystringVNDTrả về mặc định. Mã ba chữ số đại diện cho đơn vị tiền tệ dùng thanh toán đơn hàng.
codbooleanfalseTrả về mặc định. Giá trị này cho biết đơn hàng có phải là đơn hàng COD (thanh toán khi nhận) hay không.
total_amountfloat1004.0Tổng số tiền người mua đã thanh toán cho đơn hàng. Bao gồm tổng giá bán sản phẩm, phí vận chuyển do người mua chịu; và được khấu trừ bởi khuyến mãi Shopee nếu có. Giá trị này chỉ được trả về sau khi người mua hoàn tất thanh toán.
pending_termsstring[]["SYSTEM_PENDING", "KYC_PENDING"]Danh sách các điều khoản chờ xử lý. Giá trị áp dụng: - SYSTEM_PENDING: Đang được xử lý nội bộ bởi Shopee. - KYC_PENDING: Đang được kiểm tra KYC (chỉ áp dụng cho đơn hàng TW CB). - ARRANGE_SHIPMENT_PENDING: Tạm giữ do hạn chế công suất của 3PL.
pending_descriptionstring[]["Order is being processed by Shopee"]Giá trị của trường này là mô tả lý do chờ xử lý tương ứng với pending_terms. Giá trị áp dụng: - Với SYSTEM_PENDING: Đơn hàng đang được Shopee xử lý. - Với KYC_PENDING: Đơn hàng đang chờ xác thực KYC trước của người mua TW. - Với ARRANGE_SHIPMENT_PENDING: Đang phân bổ nguồn lực giao hàng do lượng đơn hàng lớn. Nhãn in sẽ khả dụng trong vòng 4 ngày sau khi thanh toán.
order_statusstringCANCELLEDTrả về mặc định. Kiểu liệt kê xác định trạng thái hiện tại của đơn hàng.
shipping_carrierstringStandard DeliveryNhà cung cấp dịch vụ logistics mà người mua chọn để giao hàng. Lưu ý: Nếu logistics_channel_id là 90021, 90025 hoặc 90026, service_code sẽ được thêm vào, ví dụ: Entrega Turbo - M1020.
payment_methodstringBank TransferPhương thức thanh toán người mua chọn để thanh toán đơn hàng. Giá trị áp dụng: Xem Định nghĩa dữ liệu - Phương thức thanh toán.
estimated_shipping_feefloat4.0Phí vận chuyển ước tính được Shopee tính dựa trên tiêu chuẩn của đơn vị vận chuyển cụ thể.
message_to_sellerstringTrả về mặc định. Tin nhắn gửi người bán.
create_timetimestamp1607930885Trả về mặc định. Dấu thời gian cho biết ngày giờ tạo đơn hàng.
update_timetimestamp1608134691Trả về mặc định. Dấu thời gian cho biết lần cuối có thay đổi trong đơn hàng, ví dụ trạng thái đổi từ 'Đã thanh toán' sang 'Hoàn thành'.
days_to_shipint322Trả về mặc định. Thời gian chuẩn bị hàng được người bán thiết lập khi đăng sản phẩm trên Shopee.
ship_by_datetimestamp1608103685Trả về mặc định. Hạn chót để giao hàng ra ngoài.
buyer_user_idint649193214ID người dùng của người mua trong đơn hàng này; sẽ trống nếu là đơn hàng không tích hợp ở khu vực TW.
buyer_usernamestringTomTên người mua; sẽ bị che dưới dạng "****" nếu là đơn hàng không tích hợp ở khu vực TW.
recipient_addressobjectĐối tượng này chứa thông tin chi tiết về địa chỉ người nhận. Các tham số có thể bị che theo từng thị trường và loại người bán. Với đơn hàng kênh tích hợp tại khu vực TW sẽ bị che toàn bộ thành "****". Xem thêm thông báo chi tiết.
namestringMaxTên người nhận tại địa chỉ đó.
phonestring3828203Số điện thoại người nhận được nhập khi đặt hàng. [Chỉ dành cho kênh không tích hợp TW] Sẽ trả về "****" khi "virtual_contact_number" khả dụng
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.
geolocationobjectThông tin định vị địa lý. Chỉ khả dụng với logistics_channel_id 90026.
latitudefloat-23.567851Vĩ độ.
longitudefloat-46.6912611Kinh độ.
actual_shipping_feefloat0.0Phí vận chuyển thực tế của đơn hàng nếu có từ đối tác logistics bên ngoài.
goods_to_declarebooleanfalseChỉ áp dụng cho đơn hàng xuyên biên giới. Giá trị này cho biết đơn hàng có chứa hàng hóa cần khai báo hải quan. "T" nghĩa là cần khai báo và sẽ được đánh dấu "T" trên nhãn vận chuyển; "F" nghĩa là không cần và sẽ đánh dấu "P". Giá trị này chỉ chính xác SAU KHI trackingNo của đơn hàng được tạo, hãy lấy giá trị này SAU KHI lấy trackingNo.
notestringhahaGhi chú người bán tạo để tham khảo cá nhân.
note_update_timetimestamp1608103685Thời gian cập nhật ghi chú.
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ể cho cùng một sản phẩm. Ví dụ: người bán có thể tạo danh sách với giá cố định cho một mẫu áo thun và cung cấp áo với nhiều màu sắc và kích thước khác nhau. 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ộ của người bán. Nhiều người bán gán SKU cho sản phẩm theo loại, kích thước và màu sắc cụ thể, đại diện cho các biến thể của một sản phẩm trong danh sách Shopee.
model_quantity_purchasedint321Số lượng sản phẩm giống nhau được mua cùng lúc bởi cùng một người mua từ một danh sách/sản phẩm.
model_original_pricefloat1000.0Giá gốc của sản phẩm theo đơn vị tiền tệ niêm yết.
model_discounted_pricefloat1000.0Giá sau chiết khấu của sản phẩm theo đơn vị tiền tệ niêm yết. Nếu không có chiết khấu, giá trị này bằng model_original_price. Với sản phẩm bundle deal, giá trị này sẽ trả về 0 vì chiết khấu bundle deal không được phân bổ đến cấp sản phẩm/biến thể. Gọi GetEscrowDetails để tính giá chiết khấu ở cấp sản phẩm cho bundle deal.
wholesalebooleanfalseGiá trị này cho biết người mua có mua sản phẩm với giá bán buôn hay không.
weightfloat12.0Trọng lượng của sản phẩm.
add_on_dealbooleanfalseCho biết sản phẩm này có thuộc addon deal hay không.
main_itembooleanfalseCho biết sản phẩm này là sản phẩm chính hay phụ. True là sản phẩm chính, false là sản phẩm phụ.
add_on_deal_idint640ID duy nhất để phân biệt các nhóm sản phẩm trong Giỏ hàng và Đơn hàng (ví dụ: AddOnDeal).
promotion_typestringflash_saleLoại khả dụng: product_promotion, flash_sale, bundle_deal, add_on_deal_main, add_on_deal_sub. Với sản phẩm tham gia nhiều khuyến mãi, chỉ hiển thị một khuyến mãi theo thứ tự ưu tiên: bundle_deal > add_on_deal_main > add_on_deal_sub > product_promotion > flash_sale
promotion_idint640ID của chương trình khuyến mãi.
order_item_idint642600144043Mã định danh của sản phẩm trong đơn hàng.
promotion_group_idint320Mã định danh của chương trình khuyến mãi sản phẩm.
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 của sản phẩm thay thế.
product_location_idstringID kho thực hiện của các sản phẩm trong đơn hàng. (Chỉ dành cho người bán đa kho)
is_prescription_itembooleanCho biết sản phẩm này có phải là sản phẩm kê đơn thuốc hay không.
consultation_idstringMã định danh của phiên tư vấn từ xa mà người mua thực hiện để đặt sản phẩm này. Trống nếu sản phẩm không được đặt qua tư vấn từ xa.
is_b2c_owned_itembooleanXác định sản phẩm có phải là sản phẩm B2C_shop_item không. Đúng ra nên là **is\_b2c\_shop\_item** nhưng do lỗi phát triển nên hiện tại là is_b2c_owned_item
promotion_listobject[]
promotion_typestringseller_discountCho biết loại khuyến mãi ở cấp sản phẩm hoặc gói được áp dụng. Mỗi sản phẩm có thể được liên kết với tối đa một khuyến mãi sản phẩm và một khuyến mãi gói cùng lúc. Item Promotions: low_price_promotion deep_discount platform_sale seller_discount flash_sale wholesale welcome_package_free_gift brand_flash_sale in_shop_flash_sale synced_promo platform_streaming_price seller_streaming_price exclusive_streamer_price price_bidding_with_rebate price_bidding_without_rebate seller_advisor_price selling_price settlement_price campaign_settlement_price local_sip_settlement_price platform_exclusive_price seller_exclusive_price seller_member_exclusive_sku item_price order_sync_price Package Promotions: bundle_deal add_on_deal_main add_on_deal_sub
promotion_idint64848474823Mã định danh duy nhất của một khuyến mãi cụ thể được áp dụng cho sản phẩm. Mỗi promotion_id tương ứng với một quy tắc hoặc chiến dịch khuyến mãi riêng biệt theo promotion_type. Giá trị dưới dạng chuỗi số.
hot_listing_itembooleantrue[Chỉ dành cho PH,TH,VN,MY,BR,TW] True nếu sản phẩm là hot listing.
pay_timetimestamp1607930885Thời điểm trạng thái đơn hàng được cập nhật từ CHƯA THANH TOÁN sang ĐÃ THANH TOÁN. Giá trị này là NULL khi đơn hàng chưa được thanh toán.
dropshipperstringChỉ dành cho đơn hàng Indonesia. Tên nhà dropshipper.
dropshipper_phonestringSố điện thoại của nhà dropshipper, có thể trống.
split_upbooleanfalseCho biết đơn hàng này có được tách thành các đơn thực hiện (forder) hay không. Gọi GetForderInfo nếu giá trị là "true".
buyer_cancel_reasonstringLý do hủy từ người mua, 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.
actual_shipping_fee_confirmedbooleanfalseDùng trường này để xác định xem actual_shipping_fee đã được xác nhận chưa.
buyer_cpf_idstringSố CPF của người mua dùng cho mục đích thuế và hóa đơn. Chỉ dành cho đơn hàng Brazil.
fulfillment_flagstringfulfilled_by_shopeeDùng trường này để cho biết đơn hàng đượ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.
package_listobject[]Danh sách gói hàng trong một đơn hàng.
package_numberstring"61630084074470"Mã định danh duy nhất của Shopee cho gói hàng trong đơn hàng.
logistics_statusstringLOGISTICS_INVALIDTrạng thái logistics của Shopee cho đơn hàng. Giá trị áp dụng: Xem Định nghĩa dữ liệu - LogisticsStatus.
logistics_channel_idint6418080Mã định danh của kênh logistics.
shipping_carrierstringStandard DeliveryNhà cung cấp dịch vụ logistics mà người mua chọn để giao hàng. Lưu ý: Nếu logistics_channel_id là 90021, 90025 hoặc 90026, service_code sẽ được thêm vào, ví dụ: Entrega Turbo - M1020.
allow_self_design_awbbooleanfalseCho biết gói hàng có cho phép tự thiết kế vận đơn (AWB) hay không. Nếu trả về false, gói hàng không cho phép tự thiết kế và chỉ có thể dùng vận đơn hệ thống.
item_listobject[]Danh sách sản phẩm.
item_idint642600144043Mã định danh duy nhất của Shopee cho một sản phẩm.
model_idint640Mã định danh duy nhất của Shopee cho một biến thể.
model_quantityint321Số lượng sản phẩm/biến thể giống nhau được mua cùng lúc bởi cùng một người mua từ một danh sách/sản phẩm.
order_item_idint642600144043Mã định danh của sản phẩm trong đơn hàng. Với các sản phẩm trong cùng một bundle deal, order_item_id sẽ chia sẻ cùng ID (ví dụ: 1,2). Với sản phẩm không trong bundle deal, order_item_id bằng item_id.
promotion_group_idint327850298Mã định danh của chương trình khuyến mãi sản phẩm.
product_location_idstringIDLID kho của sản phẩm.
parcel_chargeable_weightintTrọng lượng hiển thị dùng để tính phí vận chuyển thực tế (ASF) cho kiện hàng này.
group_shipment_idint64150654369130420Mã định danh chung cho nhiều đơn hàng được gộp vào cùng một kiện hàng.
virtual_contact_numberstring0928000886[Chỉ dành cho kênh không tích hợp TW] Số điện thoại ảo để liên hệ người nhận.
package_query_numberstring66668888[Chỉ dành cho kênh không tích hợp TW] Mã truy vấn được dùng trong các cuộc gọi qua số điện thoại ảo để liên hệ người nhận của gói hàng này.
sorting_groupstringNorth[Chỉ dành cho kênh TW 30029] Trường này cho biết giá trị nhóm phân loại của gói hàng. Chỉ khả dụng với logistics_channel_id = 30029 và sau khi gói hàng đã được sắp xếp giao hàng.
invoice_dataobjectDữ liệu hóa đơn của đơn hàng.
numberstringSố hóa đơn.
series_numberstringSố serial của hóa đơn.
access_keystringKhóa truy cập của hóa đơn.
issue_datetimestampNgày phát hành hóa đơn.
total_valuefloatTổng giá trị hóa đơn.
products_total_valuefloatTổng giá trị sản phẩm trong hóa đơn.
tax_codestringMã thuế của hóa đơn.
checkout_shipping_carrierstringStandard DeliveryVới đơn hàng không che thông tin: nhà cung cấp dịch vụ logistics người mua chọn. Với đơn hàng che thông tin: loại dịch vụ logistics người mua chọn.
reverse_shipping_feefloatShopee tính phí vận chuyển ngược cho đơn hàng bị trả lại. Giá trị của trường này sẽ không âm.
order_chargeable_weight_gramintTrọng lượng hiển thị dùng để tính phí vận chuyển thực tế (ASF) cho đơn hàng này.
prescription_check_statusintTrạng thái kiểm tra đơn thuốc. Chỉ dành cho người bán trong danh sách trắng ID và PH. Giá trị áp dụng: 0: KHÔNG CÓ 1: ĐẠT 2: KHÔNG ĐẠT
pharmacist_namestringTên dược sĩ cho đơn hàng thuốc kê đơn.
prescription_imagesstring[]Trả về hình ảnh đơn thuốc của đơn hàng này, chỉ dành cho người bán trong danh sách trắng ID và PH. Please add the prefix to review: for ID: https://cf.shopee.co.id/file/+prescription_image for PH:https://cf.shopee.ph/file/+prescription_image
prescription_approval_timetimestampThời điểm đơn thuốc được phê duyệt.
prescription_rejection_timetimestampThời điểm đơn thuốc bị từ chối.
prescription_reject_reasonstringInsufficient prescription detailTrả về lý do tại sao đơn thuốc bị từ chối. Nếu không có lý do từ chối, trả về trống.
is_buyer_shop_collectionbooleanCho biết đơn hàng này có phải là đơn hàng người mua tự đến cửa hàng nhận hay không.
buyer_proof_of_collectionstring[]URL hình ảnh bằng chứng người mua tự đến cửa hàng nhận hàng.
edt_fromtimestampNgày giao hàng ước tính sớm nhất của đơn hàng (chỉ khả dụng cho khu vực BR).
edt_totimestampThời gian giao hàng ước tính muộn nhất của đơn hàng (chỉ khả dụng cho khu vực BR).
booking_snstring2404098R48U37HTrả về mặc định. Mã định danh duy nhất của Shopee cho một booking. Chỉ trả về cho đơn hàng được khớp với đặt hàng trước.
advance_packagebooleantrueCho biết đơn hàng sẽ được thực hiện bằng tồn kho đặt trước hay không. Nếu giá trị là true, đơn hàng sẽ được khớp với booking và người bán không cần sắp xếp giao hàng.
return_request_due_datetimestampTrường này thể hiện hạn chót để người mua khởi tạo yêu cầu trả hàng/hoàn tiền sau khi đơn hàng hoàn thành. Tham số phản hồi "return_request_due_date" sẽ được trả về nếu đơn hàng đáp ứng TẤT CẢ điều kiện sau: - Trạng thái đơn hàng là COMPLETED - Đơn hàng đủ điều kiện hoàn trả Xem chi tiết tại: https://seller.shopee.tw/edu/article/18474
payment_infoobject[][Chỉ dành cho BR] Danh sách thông tin thanh toán, NT 2025.001 (BR government invoice rules).
payment_methodstringDebit Card[Chỉ dành cho BR] Phương thức thanh toán được sử dụng trong đơn hàng, như Thẻ tín dụng, Thẻ ghi nợ, Pix, v.v.
payment_processor_registerstring38.372.267/0001-82[Chỉ dành cho BR] CNPJ của đơn vị xử lý thanh toán cho giao dịch này.
card_brandstringVISA[Chỉ dành cho BR] Thương hiệu thẻ cho giao dịch tín dụng hoặc ghi nợ, như VISA, MASTER, v.v. Chuỗi rỗng cho thanh toán Pix.
transaction_idstring951679[Chỉ dành cho BR] Mã ủy quyền thanh toán được tạo bởi ngân hàng hoặc đơn vị xử lý thanh toán để xác nhận giao dịch.
payment_amountfloat1004.0[Chỉ dành cho BR] Số tiền thanh toán bằng phương thức thanh toán tương ứng.
hot_listing_orderbooleantrue[Chỉ dành cho PH,TH,VN,MY,BR,TW] True nếu đơn hàng bao gồm sản phẩm hot listing.
is_internationalbooleanfalse[Chỉ dành cho BR] Cho biết đơn hàng có phải là đơn hàng SIP hay không. Trường này chỉ được trả về nếu international_label được đưa vào response_optional_field trong yêu cầu.
warningstring[]Cho biết thông báo cảnh báo bạn cần chú ý.