v2.public.refresh_access_token

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

来自 Shopee 官方资料快照 · 2026-09-06 12:15:01

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.public.refresh_access_token

Use this API to refresh the access_token after it expires. Refresh_token can be used once only, this API will also return a new refresh_token. Please use the new refresh_token for the next RefreshAccessToken call

§2 Overview

Overview

Field	Value
Module	Public
API type	Public
HTTP method	POST
Path	/api/v2/auth/access_token/get
Production URL	https://partner.shopeemobile.com/api/v2/auth/access_token/get
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/auth/access_token/get
Rate limit	[0, 0, 0]
Permission	ERP System; Seller In House System; Product Management; Order Management; Accounting And Finance; Marketing; Customer Service; Brand Membership; Customized APP; Ads Service; Consignment Service System; Custom APP; Swam ERP; Livestream Management; Ads Facil; Affiliate Marketing Solution Management; Shopee Video Management; Brand Portal Service

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
refresh_token	string	Yes	4c7259534969484e71734d695a6e6d55	Use refresh_token to get a new access_token. Each refresh_token is valid for 30 days, and can only be used once by either a shop_id or merchant_id or supplier_id or user_id.
partner_id	int64	Yes	2001887	The partner_id obtained from the App. This partner_id is inserted into the body.
shop_id	int64	No	322300222	The shop_id that granted authorization to your App. Only the shop_id or merchant_id or supplier_id or user_id can be selected as the input parameter, and they must be refreshed separately.
merchant_id	int64	No		The merchant_id that granted authorization to your App. Only the shop_id or merchant_id or supplier_id or user_id can be selected as the input parameter, and they must be refreshed separately.
supplier_id	int64	No		The supplier_id that granted authorization to your App. Only the shop_id or merchant_id or supplier_id or user_id can be selected as the input parameter, and they must be refreshed separately.
user_id	int64	No		The user_id that granted authorization to your App. Only the shop_id or merchant_id or supplier_id or user_id can be selected as the input parameter, and they must be refreshed separately.
principal_id	int64	No		Shopee's unique identifier for a principal.

§4 Response parameters

Response parameters

Name	Type	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	The identifier for an API request for error tracking.
partner_id	int64	Returned when the API call is successful. The partner_id you used for this refresh.
principal_id	int64	Returned when the API call is successful.The principal_id for this refresh.
shop_id	int64	Returned when the API call is successful. The shop_id for this refresh.
merchant_id	int64	Returned when the API call is successful. The merchant_id for this refresh.
supplier_id	int64	Returned when the API call is successful. The supplier_id for this refresh.
user_id	int64	Returned when the API call is successful. The user_id for this refresh.
access_token	string	Returned when the API call is successful. Each new access_token is a dynamic token that can be used multiple times. It expires after 4 hours.
refresh_token	string	New refresh_tokenReturned when the API call is successful. Use a refresh_token to get a new access_token. Each refresh_token is valid for 30 days, and can only be used once by either a shop_id or merchant_id or supplier_id or user_id.
expire_in	timestamp	Returned when the API call is successful. The validity period of the access_token, in seconds.

§5 Common parameters

Common parameters

Name	Type	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.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp 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

{
	"refresh_token": "4c7259534969484e71734d695a6e6d55",
	"partner_id": 2001887,
	"shop_id": 322300222
}

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/auth/access_token/get?partner_id=partner_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"partner_id\": 2001887,
   \"refresh_token\": \"4c7259534969484e71734d695a6e6d55\",
   \"shop_id\": 322300222
}")
.asString();

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/auth/access_token/get?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 => 'POST',
  CURLOPT_POSTFIELDS => '{
    "partner_id": 2001887,
    "refresh_token": "4c7259534969484e71734d695a6e6d55",
    "shop_id": 322300222
}',
  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.shopeemobile.com/api/v2/auth/access_token/get?partner_id=partner_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "partner_id": 2001887,
   "refresh_token": "4c7259534969484e71734d695a6e6d55",
   "shop_id": 322300222
}'

§11 Python

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/auth/access_token/get?partner_id=partner_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "partner_id": 2001887,
  "refresh_token": "4c7259534969484e71734d695a6e6d55",
  "shop_id": 322300222
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§12 Response sample

Response sample

§13 JSON

JSON

{
    "error": "",
    "message": "",
    "request_id": "83089a02e46d77b64882c0c93aba5267",
    "partner_id": 2001887,
    "shop_id": 322300222,
    "access_token": "71594a4c54537649697341796363674a",
    "refresh_token": "516c6b577753554375764a63704d7245",
    "expire_in": 14400
}

§14 Error example

Error example

§15 JSON

JSON

{
    "error": "error_auth",
    "message": "Invalid refresh_token.",
    "request_id": "d95d6db199da20e3fe1c913a54dc6746"
}

§16 Errors

Errors

Error	Description	Solution
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.
merchant_access_expired	Your access to merchant has expired.
merchant_no_linked	Partner and merchant has no linked.
error_merchant_refresh_token	Your refresh token is error,please check refresh token or merchant_id.
error_param	request not from gateway
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
refresh_token_expired	Your refresh_token expired.
error_server	error server
shop_access_expired	Your access to shop has expired.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
shop_no_linked	Partner and shop has no linked.
error_shop_refresh_token	Your refresh token is error ,please check refresh token or shopid.
supplier_access_expired	Your access to supplier has expired.
supplier_no_linked	Partner and Supplier has no linked.
error_merchant_refresh_token	Your refresh token is error ,please check refresh token or supplier_id.

§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.

§18 Update log

Update log

Date	Change
2026-07-13	Add principal_id as request and response parameters.
2021-09-02	update

这条内容对你有帮助吗？