stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§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
| Field | Value |
|---|---|
| Module | Order |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/order/get_buyer_invoice_info |
| Production URL | https://partner.shopeemobile.com/api/v2/order/get_buyer_invoice_info |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/order/get_buyer_invoice_info |
| Permission | ERP System; Seller In House System; Order Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| queries | object[] | Yes | ||
| queries.order_sn | string | Yes | 220314U0G6UNMN | Shopee's unique identifier for an order. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| invoice_info_list | object[] | |||
| invoice_info_list.order_sn | string | 220314U0G6UNMN | Shopee's unique identifier for an order. | |
| invoice_info_list.invoice_type | string | personal | Type of invoice requested: {1: personal, 2: company, 3: household}. | |
| invoice_info_list.invoice_detail | object | Invoice info submitted by buyer. Might be masked, e.g. A****b, depending on order status. | ||
| invoice_info_list.invoice_detail.name | string | Tom Jerry | Buyer name (has value when invoice_type is personal, household, or company); - VN, TH, PH only | |
| invoice_info_list.invoice_detail.email | string | tom.and.jerry@gmail.com | Buyer email address (has value when invoice_type is personal and household); - VN, TH, PH only | |
| invoice_info_list.invoice_detail.phone_number | string | (+66) 828918689 | Buyer phone number; - TH only | |
| invoice_info_list.invoice_detail.tax_id | string | 1234567898 | has value when invoice_type is personal and household.; - VN, TH, PH only | |
| invoice_info_list.invoice_detail.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 | |
| invoice_info_list.invoice_detail.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). | |
| invoice_info_list.invoice_detail.address_breakdown | object | Buyer address breakdown.; - TH, PH only | ||
| invoice_info_list.invoice_detail.address_breakdown.region | string | Thailand | Return region value; - PH, TH only | |
| invoice_info_list.invoice_detail.address_breakdown.state | string | Małopolskie | Return value; - TH: Province | |
| invoice_info_list.invoice_detail.address_breakdown.city | string | Myślenicki | Return value; - TH: District | |
| invoice_info_list.invoice_detail.address_breakdown.town | string | Łęki | Return value; - TH: Sub district | |
| invoice_info_list.invoice_detail.address_breakdown.postcode | string | 17200 | Return value; - TH: Postal code; - PH: Postal code | |
| invoice_info_list.invoice_detail.address_breakdown.detailed_address | string | GieŁdowa 4b | Return value; - PH: Additional details, i.e. street name, building; - TH: Additional details, i.e. house number | |
| invoice_info_list.invoice_detail.address_breakdown.additional_info | string | PIĄTE PIĘTRO | Return value: - Empty for PH, TH | |
| invoice_info_list.invoice_detail.address_breakdown.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 | |
| invoice_info_list.invoice_detail.company_head_office | string | yes | - return value for TH only (only has value when invoice_type is company) | |
| invoice_info_list.invoice_detail.company_name | string | Michal Orwinski S.C. | - Only return value when invoice type is company; - VN, TH, PH only | |
| invoice_info_list.invoice_detail.company_branch_name | string | CIty A branch | - Only return value when invoice type is company; - TH only | |
| invoice_info_list.invoice_detail.company_branch_id | string | 123 | - Only return value when invoice type is company; - TH only | |
| invoice_info_list.invoice_detail.company_type | string | head office | - Only return value when invoice type is company; - TH only | |
| invoice_info_list.invoice_detail.company_email | string | michal@shopee.com | - Only return value when invoice type is company; - VN, TH, PH only | |
| invoice_info_list.invoice_detail.company_tax_id | string | 123456789 | - Only return value when invoice type is company; - VN, TH, PH only | |
| invoice_info_list.invoice_detail.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 | |
| invoice_info_list.invoice_detail.company_address_breakdown | object | Company address breakdown; - PH, TH only | ||
| invoice_info_list.invoice_detail.company_address_breakdown.company_region | string | Thailand | Return region value; - PH, TH only | |
| invoice_info_list.invoice_detail.company_address_breakdown.company_state | string | Małopolskie | Return value; - PH: Province; - TH: Province | |
| invoice_info_list.invoice_detail.company_address_breakdown.company_city | string | Myślenicki | Return value; - PH: City | |
| invoice_info_list.invoice_detail.company_address_breakdown.company_district | string | Myślenice | Return value; - PH: Barangay; - TH: District | |
| invoice_info_list.invoice_detail.company_address_breakdown.company_town | string | Łęki | Return value; - TH: Sub district | |
| invoice_info_list.invoice_detail.company_address_breakdown.company_postcode | string | 17200 | Return postal code; - TH, PH only | |
| invoice_info_list.invoice_detail.company_address_breakdown.company_detailed_address | string | GieŁdowa 4b | Return value; - PH: Detailed address; - TH: Detailed address | |
| invoice_info_list.invoice_detail.company_address_breakdown.company_additional_info | string | PIĄTE PIĘTRO | Return value: - Empty for PH, TH | |
| invoice_info_list.invoice_detail.company_address_breakdown.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 | |
| invoice_info_list.invoice_detail.household_address_breakdown | object | Household address breakdown; -Only for VN | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_region | string | Region of the household address. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_state | string | State of the household address. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_city | string | City of the household address. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_province | string | Province of the household address. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_district | string | District of the household address. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_town | string | Town of the household address. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_barangay | string | Barangay of the household address. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_postcode | string | Postal code of the household address. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_detailed_address | string | Detailed street address of the household. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_additional_info | string | Additional address information provided by the buyer. | ||
| invoice_info_list.invoice_detail.household_address_breakdown.household_full_address | string | Full formatted household address. | ||
| invoice_info_list.invoice_detail.national_id | string | National ID information provided by the buyer.; - Only return value when invoice_type is personal - VN only | ||
| invoice_info_list.error | string | order not found | Error in retrieving the receipt setting of a particular order. | |
| invoice_info_list.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 | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Invalid access_token. | Indicate error details if hit error. Empty if no error happened. |
§5 Common parameters
Common parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. | |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. | |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. | |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature 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×tamp=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×tamp=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×tamp=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
| Error | Description | Solution |
|---|---|---|
| error_param | Order SN is a required parameter. Please check your request data. | |
| error_database | Query data from database failed. | |
| error_param | The Order SN is duplicated. | |
| error_order | Something wrong. Please try again later. | |
| internal_error | Something wrong. Please try again later. | |
| error_network | Inner http call failed | |
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_shop | shopid is invalid | |
| error_param | request not from gateway | |
| error_order | System error, please try again later. | |
| error_network | This API is only available for TH, VN, PH region | |
| error_order | Something wrong. Please try again later. | |
| error_order | Something wrong. Please try again later. | |
| error_order | Something wrong. Please try again later. | |
| error_network | Connection issue. Please try again later. | |
| error_order | Something wrong. Please try again later. | |
| error_shop | System error, please try again later. | |
| error_shop | Something wrong. Please try again later. | |
| error_shop | Something wrong. Please try again later. | |
| error_network | Connection issue. Please try again later. | |
| error_shop | Something wrong. Please try again later. |
§17 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App 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_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The 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_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The 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_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your 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_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
§18 Update log
Update log
| Date | Change |
|---|---|
| 2026-07-30 | Added "national_id" as response parameters |
| 2026-03-10 | Updating name, address, tax_id, and email with household |
| 2022-09-30 | add TH to use this API |
| 2022-09-22 | update to add "is_requested"filed |
| 2022-07-21 | add some new fields for AR sellers |
