快工助手跨境电商知识与商机助手

v2.order.get_buyer_invoice_info

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.order.get_buyer_invoice_info

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

#

§2 Overview

Overview

FieldValue
ModuleOrder
API typeShop
HTTP methodPOST
Path/api/v2/order/get_buyer_invoice_info
Production URLhttps://partner.shopeemobile.com/api/v2/order/get_buyer_invoice_info
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/order/get_buyer_invoice_info
PermissionERP System; Seller In House System; Order Management; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
queriesobject[]Yes
queries.order_snstringYes220314U0G6UNMNShopee's unique identifier for an order.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
invoice_info_listobject[]
invoice_info_list.order_snstring220314U0G6UNMNShopee's unique identifier for an order.
invoice_info_list.invoice_typestringpersonalType of invoice requested: {1: personal, 2: company, 3: household}.
invoice_info_list.invoice_detailobjectInvoice info submitted by buyer. Might be masked, e.g. A****b, depending on order status.
invoice_info_list.invoice_detail.namestringTom JerryBuyer name (has value when invoice_type is personal, household, or company); - VN, TH, PH only
invoice_info_list.invoice_detail.emailstringtom.and.jerry@gmail.comBuyer email address (has value when invoice_type is personal and household); - VN, TH, PH only
invoice_info_list.invoice_detail.phone_numberstring(+66) 828918689Buyer phone number; - TH only
invoice_info_list.invoice_detail.tax_idstring1234567898has value when invoice_type is personal and household.; - VN, TH, PH only
invoice_info_list.invoice_detail.addressstringGieŁdowa 4b, Długi Bród, 17200, PIĄTE PIĘTROBuyer 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
invoice_info_list.invoice_detail.id_card_addressstringGieŁdowa 4b, Długi Bród, 17200, PIĄTE PIĘTROSame 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).
invoice_info_list.invoice_detail.address_breakdownobjectBuyer address breakdown.; - TH, PH only
invoice_info_list.invoice_detail.address_breakdown.regionstringThailandReturn region value; - PH, TH only
invoice_info_list.invoice_detail.address_breakdown.statestringMałopolskieReturn value; - TH: Province
invoice_info_list.invoice_detail.address_breakdown.citystringMyślenickiReturn value; - TH: District
invoice_info_list.invoice_detail.address_breakdown.townstringŁękiReturn value; - TH: Sub district
invoice_info_list.invoice_detail.address_breakdown.postcodestring17200Return value; - TH: Postal code; - PH: Postal code
invoice_info_list.invoice_detail.address_breakdown.detailed_addressstringGieŁdowa 4bReturn value; - PH: Additional details, i.e. street name, building; - TH: Additional details, i.e. house number
invoice_info_list.invoice_detail.address_breakdown.additional_infostringPIĄTE PIĘTROReturn value: - Empty for PH, TH
invoice_info_list.invoice_detail.address_breakdown.full_addressstringGieŁ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
invoice_info_list.invoice_detail.company_head_officestringyes- return value for TH only (only has value when invoice_type is company)
invoice_info_list.invoice_detail.company_namestringMichal Orwinski S.C.- Only return value when invoice type is company; - VN, TH, PH only
invoice_info_list.invoice_detail.company_branch_namestringCIty A branch- Only return value when invoice type is company; - TH only
invoice_info_list.invoice_detail.company_branch_idstring123- Only return value when invoice type is company; - TH only
invoice_info_list.invoice_detail.company_typestringhead office- Only return value when invoice type is company; - TH only
invoice_info_list.invoice_detail.company_emailstringmichal@shopee.com- Only return value when invoice type is company; - VN, TH, PH only
invoice_info_list.invoice_detail.company_tax_idstring123456789- Only return value when invoice type is company; - VN, TH, PH only
invoice_info_list.invoice_detail.company_addressstringGieŁdowa 4b, Długi Bród, 17200, PIĄTE PIĘTROBuyer address in format "Street & number,city, zipcode, any additional info provided by buyer" (only has value when invoice_type is company); - VN, TH only
invoice_info_list.invoice_detail.company_address_breakdownobjectCompany address breakdown; - PH, TH only
invoice_info_list.invoice_detail.company_address_breakdown.company_regionstringThailandReturn region value; - PH, TH only
invoice_info_list.invoice_detail.company_address_breakdown.company_statestringMałopolskieReturn value; - PH: Province; - TH: Province
invoice_info_list.invoice_detail.company_address_breakdown.company_citystringMyślenickiReturn value; - PH: City
invoice_info_list.invoice_detail.company_address_breakdown.company_districtstringMyśleniceReturn value; - PH: Barangay; - TH: District
invoice_info_list.invoice_detail.company_address_breakdown.company_townstringŁękiReturn value; - TH: Sub district
invoice_info_list.invoice_detail.company_address_breakdown.company_postcodestring17200Return postal code; - TH, PH only
invoice_info_list.invoice_detail.company_address_breakdown.company_detailed_addressstringGieŁdowa 4bReturn value; - PH: Detailed address; - TH: Detailed address
invoice_info_list.invoice_detail.company_address_breakdown.company_additional_infostringPIĄTE PIĘTROReturn value: - Empty for PH, TH
invoice_info_list.invoice_detail.company_address_breakdown.company_full_addressstringGieŁdowa 4b, Łęki, 17200, PIĄTE PIĘTROConcatenation of company address breakdown; - only has value when invoice_type is company
invoice_info_list.invoice_detail.household_address_breakdownobjectHousehold address breakdown; -Only for VN
invoice_info_list.invoice_detail.household_address_breakdown.household_regionstringRegion of the household address.
invoice_info_list.invoice_detail.household_address_breakdown.household_statestringState of the household address.
invoice_info_list.invoice_detail.household_address_breakdown.household_citystringCity of the household address.
invoice_info_list.invoice_detail.household_address_breakdown.household_provincestringProvince of the household address.
invoice_info_list.invoice_detail.household_address_breakdown.household_districtstringDistrict of the household address.
invoice_info_list.invoice_detail.household_address_breakdown.household_townstringTown of the household address.
invoice_info_list.invoice_detail.household_address_breakdown.household_barangaystringBarangay of the household address.
invoice_info_list.invoice_detail.household_address_breakdown.household_postcodestringPostal code of the household address.
invoice_info_list.invoice_detail.household_address_breakdown.household_detailed_addressstringDetailed street address of the household.
invoice_info_list.invoice_detail.household_address_breakdown.household_additional_infostringAdditional address information provided by the buyer.
invoice_info_list.invoice_detail.household_address_breakdown.household_full_addressstringFull formatted household address.
invoice_info_list.invoice_detail.national_idstringNational ID information provided by the buyer.; - Only return value when invoice_type is personal - VN only
invoice_info_list.errorstringorder not foundError in retrieving the receipt setting of a particular order.
invoice_info_list.is_requestedbooleanfalseTo identify order with and without buyer request, applicable to PL.
request_idstringZQKEZfwaNQUnMKqMmjWuRPybfshyFygVRequest id for debugging purposes
errorstringcommon.error_authIndicate error type if hit error. Empty if no error happened.
messagestringInvalid access_token.Indicate error details if hit error. Empty if no error happened.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2
#

§6 Request samples

Request samples

#

§7 Payload

Payload

{
	"queries": [
		{
			"order_sn": "220314U0G6UNMN"
		}
	]
}
#

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.uat.shopeemobile.com/api/v2/order/get_buyer_invoice_info?timestamp=timestamp&shop_id=shop_id&partner_id=partner_id&sign=sign&access_token=access_token")
.header("Content-Type","application/json")
.body("{
   \"queries\": [
      {
         \"order_sn\": \"220314U0G6UNMN\"
      }
   ]
}")
.asString();
#

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.uat.shopeemobile.com/api/v2/order/get_buyer_invoice_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "queries": [
        {
            "order_sn": "220314U0G6UNMN"
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§10 cURL

cURL

curl --location --request POST 'https://partner.uat.shopeemobile.com/api/v2/order/get_buyer_invoice_info?partner_id=partner_id&sign=sign&access_token=access_token&timestamp=timestamp&shop_id=shop_id' \
--header 'Content-Type: application/json' \
--data-raw '{
   "queries": [
      {
         "order_sn": "220314U0G6UNMN"
      }
   ]
}'
#

§11 Python

Python

import requests
import json

url = "https://partner.uat.shopeemobile.com/api/v2/order/get_buyer_invoice_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "queries": [
    {
      "order_sn": "220314U0G6UNMN"
    }
  ]
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.request("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§12 Response sample

Response sample

#

§13 JSON

JSON

{
    "request_id": "a2c45ca2683caf1651ecab5a4d5942ce",
    "error": "",
    "message": "",
    "invoice_info_list": [
        {
            "order_sn": "2209160VNPKXF7",
            "invoice_type": "personal",
            "invoice_detail": {
                "name": "Kevin Yap",
                "email": "testing.just@op.pl",
                "address": "Ordona 7B Warszawa, Warszawa, 01237",
                "phone_number": "",
                "tax_id": "",
                "address_breakdown": {
                    "region": "Poland",
                    "state": "",
                    "city": "Warszawa",
                    "district": "",
                    "town": "Warszawa",
                    "postcode": "01237",
                    "detailed_address": "Ordona 7B Warszawa",
                    "additional_info": "",
                    "full_address": "Ordona 7B Warszawa, Warszawa, 01237"
                }
            },
            "is_requested": false,
            "error": ""
        }
    ]
}
#

§14 Error example

Error example

#

§15 JSON

JSON

{
    "request_id": "327af1d09bf6fe6a710633a9cf516ea5",
    "error": "",
    "message": "",
    "invoice_info_list": [
        {
            "order_sn": "2205134ANQVP7X",
            "invoice_type": "",
            "invoice_detail": null,
            "error": "receipt settings not found"
        }
    ]
}
#

§16 Errors

Errors

ErrorDescriptionSolution
error_paramOrder SN is a required parameter. Please check your request data.
error_databaseQuery data from database failed.
error_paramThe Order SN is duplicated.
error_orderSomething wrong. Please try again later.
internal_errorSomething wrong. Please try again later.
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_shopshopid is invalid
error_paramrequest not from gateway
error_orderSystem error, please try again later.
error_networkThis API is only available for TH, VN, PH region
error_orderSomething wrong. Please try again later.
error_orderSomething wrong. Please try again later.
error_orderSomething wrong. Please try again later.
error_networkConnection issue. Please try again later.
error_orderSomething wrong. Please try again later.
error_shopSystem error, please try again later.
error_shopSomething wrong. Please try again later.
error_shopSomething wrong. Please try again later.
error_networkConnection issue. Please try again later.
error_shopSomething wrong. Please try again later.
#

§17 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspendedThe API is offline. Please call v2 API instead.
error_limitThe total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§18 Update log

Update log

DateChange
2026-07-30Added "national_id" as response parameters
2026-03-10Updating name, address, tax_id, and email with household
2022-09-30add TH to use this API
2022-09-22update to add "is_requested"filed
2022-07-21add some new fields for AR sellers
#