stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.shop.get_br_shop_onboarding_info
[For BR Shop Only] Use this API to get shop KYC registration and qualification information.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Shop |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/shop/get_br_shop_onboarding_info |
| Production URL | https://partner.shopeemobile.com/api/v2/shop/get_br_shop_onboarding_info |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/shop/get_br_shop_onboarding_info |
| Permission | ERP System; Seller In House System; Product Management; Order Management |
§3 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | ||
| message | string | Indicate error details if hit error. Empty if no error happened. | ||
| request_id | string | 6745b892295d750abf83a29430510400 | The identifier for an API request for error tracking. | |
| response | object | Onboarding information of the Shop. | ||
| response.tax_id_type | int32 | Type of the shop’s tax ID. Applicable values: 1: Personal seller (CPF) 2: Company seller (CNPJ) | ||
| response.tax_id | string | The shop’s tax ID. - When tax_id_type = 1 (Personal seller), it is CPF.; - When tax_id_type = 2 (Company seller), it is CNPJ. | ||
| response.cpf_id | string | CPF number of the individual seller. Valid only when tax_id_type = 1. | ||
| response.cnpj_id | string | CNPJ number of the company seller. Valid only when tax_id_type = 2. | ||
| response.name | string | Full name of the individual seller. Valid only when tax_id_type = 1. | ||
| response.legal_entity_name | string | Legal name of the company seller. Valid only when tax_id_type = 2. | ||
| response.birthday | int64 | Birthday of the individual seller (stored as Unix timestamp). Valid only when tax_id_type = 1. | ||
| response.birthday_str | string | Birthday of the individual seller (formatted as YYYY-MM-DD). Valid only when tax_id_type = 1. | ||
| response.state_registration | string | State registration number of the shop. | ||
| response.billing_address | object | Shop’s billing address details. | ||
| response.billing_address.state | string | State of the billing address. | ||
| response.billing_address.city | string | City of the billing address. | ||
| response.billing_address.address | string | Specific detail of the billing address. | ||
| response.billing_address.zipcode | string | ZIP code of the billing address. | ||
| response.billing_address.neighborhood | string | Neighborhood of the billing address. | ||
| response.onboarding_status | int32 | Status of the shop’s current KYC onboarding process. Applicable values: 0: None 1: Regis Processing; 2: Regis Validated; 3: Regis Rejected; 4: KYC Pending 5: KYC Processing 6: KYC Processing Manually 7: KYC Validated 8: KYC Rejected | ||
| response.submission_time | int32 | Timestamp when the onboarding information was submitted. | ||
| response.nationality | string | Nationality of the individual seller. Valid only when tax_id_type=1. | ||
| response.cnae_main | string | Main CNAE code. | ||
| response.cnae_secondary | string | Secondary CNAE code. | ||
| response.mei_check | string | MEI verification result. Applicable values: 0: No 1: Yes | ||
| response.onboarding_passed | boolean | Indicate if the shop has passed KYC verification. |
§4 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 |
§5 Request samples
Request samples
§6 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/shop/get_br_shop_onboarding_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp")
.asString();
§7 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/shop/get_br_shop_onboarding_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 => 'GET',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§8 cURL
cURL
curl --location --request GET 'https://partner.shopeemobile.com/api/v2/shop/get_br_shop_onboarding_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp'
§9 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/shop/get_br_shop_onboarding_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp"
payload={}
headers = {
}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§10 Response sample
Response sample
§11 JSON
JSON
{
"response": {
"billing_address": {
"address": "api, str, ",
"city": "Barracão",
"name": "",
"neighborhood": "Operario",
"phone": "",
"state": "Rio Grande do Sul",
"zipcode": "95370000"
},
"cnae_main": "47.51-2-01 - Comércio varejista especializado de equipamentos e suprimentos de informática",
"cnae_secondary": "[\"47.42-3-00 - Comércio varejista de material elétrico\",\"47.89-0-99 - Comércio varejista de outros produtos não especificados anteriormente\",\"45.30-7-03 - Comércio a varejo de peças e acessórios novos para veículos automotores\",\"47.57-1-00 - Comércio varejista especializado de peças e acessórios para aparelhos eletroeletrônicos para uso doméstico, exceto informática e comunicação\",\"47.52-1-00 - Comércio varejista especializado de equipamentos de telefonia e comunicação\",\"47.81-4-00 - Comércio varejista de artigos do vestuário e acessórios\",\"45.41-2-06 - Comércio a varejo de peças e acessórios novos para motocicletas e motonetas\",\"47.63-6-03 - Comércio varejista de bicicletas e triciclos; peças e acessórios\",\"47.63-6-02 - Comércio varejista de artigos esportivos\",\"47.54-7-03 - Comércio varejista de artigos de iluminação\",\"47.82-2-02 - Comércio varejista de artigos de viagem\",\"47.89-0-07 - Comércio varejista de equipamentos para escritório\",\"47.82-2-01 - Comércio varejista de calçados\",\"47.83-1-02 - Comércio varejista de artigos de relojoaria\",\"47.83-1-01 - Comércio varejista de artigos de joalheria\"]",
"cnpj_id": "55585487000103",
"legal_entity_name": "55.585.487 Luiz Felipe Santos Spanholi",
"mei_check": "1",
"onboarding_passed": true,
"onboarding_status": 7,
"state_registration": "8003688866",
"submission_time": 1761559361,
"tax_id": "55585487000103",
"tax_id_type": 2
},
"request_id": "2e17701b64d646e293bfa53f1882d440"
}
§12 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| 10011 | err_service_internal | |
| 10002 | error_shop_not_exists |
§13 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. |
§14 Update log
Update log
| Date | Change |
|---|---|
| 2025-12-04 | New API |
