v2.order.get_buyer_invoice_info

POST /api/v2/order/get_buyer_invoice_info

API to obtain buyer submitted invoice info for VN, TH and PH local sellers only.

Đường dẫn Endpoint

URL: https://partner.shopeemobile.com/api/v2/order/get_buyer_invoice_info

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
queries	object[]	False
order_sn	string	True	220314U0G6UNMN	Mã định danh duy nhất của Shopee cho một đơn hàng.

Tham số Response

Name	Type	Sample	Description
invoice_info_list	object[]
order_sn	string	220314U0G6UNMN	Mã định danh duy nhất của Shopee cho một đơn hàng.
invoice_type	string	personal	Type of invoice requested: {1: personal, 2: company, 3: household}.
invoice_detail	object		Invoice info submitted by buyer. Might be masked, e.g. A****b, depending on order status.
name	string	Tom Jerry	Buyer name (has value when invoice_type is personal, household, or company) - VN, TH, PH only
email	string	tom.and.jerry@gmail.com	Buyer email address (has value when invoice_type is personal and household) - VN, TH, PH only
phone_number	string	(+66) 828918689	Buyer phone number - TH only
tax_id	string	1234567898	has value when invoice_type is personal and household.  - VN, TH, PH only
address	string	GieŁdowa 4b, Długi Bród, 17200, PIĄTE PIĘTRO	Buyer address in format "Street & number, city, zipcode, any additional info provided by buyer" (has value when invoice_type is personal and household) - PH, VN only
id_card_address	string	GieŁdowa 4b, Długi Bród, 17200, PIĄTE PIĘTRO	Same function as the address, only having a different field name for TH.Buyer address in format "Street & number, city, zipcode, any additional info provided by buyer" (only has value when invoice_type is personal).
address_breakdown	object		Buyer address breakdown. - TH, PH only
region	string	Thailand	Return region value - PH, TH only
state	string	Małopolskie	Return value - TH: Province
city	string	Myślenicki	Return value - TH: District
town	string	Łęki	Return value - TH: Sub district
postcode	string	17200	Return value - TH: Postal code - PH: Postal code
detailed_address	string	GieŁdowa 4b	Return value - PH: Additional details, i.e. street name, building - TH: Additional details, i.e. house number
additional_info	string	PIĄTE PIĘTRO	Return value: - Empty for PH, TH
full_address	string	GieŁdowa 4b, Łęki, 17200, PIĄTE PIĘTRO	- only has value when invoice_type is personal - Buyer address in format "detailed_address, town, district, state, postcode, additional_info" for all regions --- for TH: leave the 'additional_info' as empty
company_head_office	string	yes	- return value for TH only (only has value when invoice_type is company)
company_name	string	Michal Orwinski S.C.	- Chỉ trả về giá trị khi loại hóa đơn là công ty - Chỉ áp dụng cho VN, TH, PH
company_branch_name	string	CIty A branch	- Chỉ trả về giá trị khi loại hóa đơn là công ty - Chỉ áp dụng cho TH
company_branch_id	string	123	- Chỉ trả về giá trị khi loại hóa đơn là công ty - Chỉ áp dụng cho TH
company_type	string	head office	- Chỉ trả về giá trị khi loại hóa đơn là công ty - Chỉ áp dụng cho TH
company_email	string	michal@shopee.com	- Chỉ trả về giá trị khi loại hóa đơn là công ty - Chỉ áp dụng cho VN, TH, PH
company_tax_id	string	123456789	- Chỉ trả về giá trị khi loại hóa đơn là công ty - Chỉ áp dụng cho VN, TH, PH
company_address	string	GieŁdowa 4b, Długi Bród, 17200, PIĄTE PIĘTRO	Buyer address in format "Street & number,city, zipcode, any additional info provided by buyer" (only has value when invoice_type is company) - VN, TH only
company_address_breakdown	object		Company address breakdown - PH, TH only
company_region	string	Thailand	Return region value - PH, TH only
company_state	string	Małopolskie	Return value - PH: Province - TH: Province
company_city	string	Myślenicki	Return value - PH: City
company_district	string	Myślenice	Return value - PH: Barangay - TH: District
company_town	string	Łęki	Return value - TH: Sub district
company_postcode	string	17200	Return postal code - TH, PH only
company_detailed_address	string	GieŁdowa 4b	Return value - PH: Detailed address - TH: Detailed address
company_additional_info	string	PIĄTE PIĘTRO	Return value: - Empty for PH, TH
company_full_address	string	GieŁdowa 4b, Łęki, 17200, PIĄTE PIĘTRO	Concatenation of company address breakdown - only has value when invoice_type is company
household_address_breakdown	object		Thông tin địa chỉ hộ gia đình chi tiết - Chỉ dành cho VN
household_region	string		Region of the household address.
household_state	string		State of the household address.
household_city	string		City of the household address.
household_province	string		Province of the household address.
household_district	string		District of the household address.
household_town	string		Town of the household address.
household_barangay	string		Barangay of the household address.
household_postcode	string		Postal code of the household address.
household_detailed_address	string		Detailed street address of the household.
household_additional_info	string		Additional address information provided by the buyer.
household_full_address	string		Full formatted household address.
error	string	order not found	Error in retrieving the receipt setting of a particular order.
is_requested	boolean	false	To identify order with and without buyer request, applicable to PL.
request_id	string	ZQKEZfwaNQUnMKqMmjWuRPybfshyFygV	Request id for debugging purposes
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.