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

v2.merchant.get_merchant_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.merchant.get_merchant_info

Use this call to get information of merchant

#

§2 Overview

Overview

FieldValue
ModuleMerchant
API typeMerchant
HTTP methodGET
Path/api/v2/merchant/get_merchant_info
Production URLhttps://partner.shopeemobile.com/api/v2/merchant/get_merchant_info
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/merchant/get_merchant_info
Rate limit[0, 0, 0]
PermissionERP System; Seller In House System; Product Management; Ads Service; Swam ERP
#

§3 Response parameters

Response parameters

NameTypeRequiredSampleDescription
merchant_namestringsellerplatform_uat_merchantName of the merchant.
auth_timetimestamp1608114596The timestamp when the merchant was authorized to the partner.
expire_timetimestamp1640342010Use this field to indicate the expiration date for merchant authorization.
request_idstringa3a4277823b1019960cc92cfd972c506The identifier for an API request for error tracking.
merchant_currencystringCNYThe three-digit code representing the currency unit used for the item in this merchant. If currency haven't been setting in CNSC/KRSC, it will be empty.; China merchant support CNY and USD currently.; Korea merchant support KRW and USD currently.; Hong kong merchant support USD currently, will support HKD later.
merchant_regionstringKRRegion of the merchant. Including KR, HK and CN.
is_upgraded_cbscbooleantrueUse this filed to indicate whether this merchant is upgraded to cbsc.
#

§4 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.
merchant_idint1Shopee’s unique identifier for a merchant. Required for all merchant level requests(CB CNSC user calling global product related APIs).
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature generated by partner_id, api path, timestamp, access_token, merchant_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/merchant/get_merchant_info?access_token=access_token&merchant_id=merchant_id&partner_id=partner_id&sign=sign&timestamp=timestamp")
.asString();
#

§7 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/merchant/get_merchant_info?access_token=access_token&merchant_id=merchant_id&partner_id=partner_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 => '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/merchant/get_merchant_info?access_token=access_token&merchant_id=merchant_id&partner_id=partner_id&sign=sign&timestamp=timestamp' 
#

§9 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/merchant/get_merchant_info?access_token=access_token&merchant_id=merchant_id&partner_id=partner_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§10 Response sample

Response sample

#

§11 JSON

JSON

{
    "merchant_name": "CNSC Company 7",
    "is_cnsc": true,
    "request_id": "4022b2fcf376045bba533b504e02476a",
    "auth_time": 1650624369,
    "expire_time": 1682179199,
    "merchant_currency": "CNY",
    "merchant_region": "CN",
    "is_upgraded_cbsc": true,
    "error": "",
    "message": ""
}
#

§12 Error example

Error example

#

§13 JSON

JSON

{
    "request_id": "cc4740098d56fd2fa010325f388c8c88",
    "error": "error_auth",
    "message": "Invalid partner_id."
}
#

§14 Errors

Errors

ErrorDescriptionSolution
ERROR_MERCHANT_UNSET_CURRENCY_INFOThe merchant has not set the currency. Please log in to CBSC to make the settings.
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_paramThe merchant id you provided is not found. Please check your merchant id.
error_paramrequest not from gateway
#

§15 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.
merchant_no_linkedPartner and merchant has no linked.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_frozenThe Partner has been frozen. Permissions for merchant authorization and API calls have been suspended until permissions are restored.
error_paramThere is no merchant_id in query.
error_parammerchant_id is invalid, should be an integer between 0 and 4294967295.
#

§16 Update log

Update log

DateChange
2024-10-23sunset the is_cnsc
2023-10-26update the description of "merchant_region" and "merchant_currency"
2021-11-18add merchant_currency response parameters
#