Use the code from the authorization step to call this API to obtain the authorized shop_id, merchant_id, supplier_id, or user_id, and its corresponding access_token and refresh_token.
ID of API requests; always returned. Used to diagnose problems.
shop_id_list
int64[]
Returned all shop_ids authorized this time.
merchant_id_list
int64[]
Returned all merchant_ids authorized this time.
supplier_id_list
int64[]
Returned all supplier_ids authorized this time.
user_id_list
int64[]
Returned all user_ids authorized this time.
principal_id_list
int64[]
If the authorized role is principal administrator, return all principal_id under this authorization.
access_token
string
Returned when the API call is successful. A dynamic token that can be used multiple times and expires after 4 hours.
refresh_token
string
Returned when the API call is successful. Use refresh_token to get a new access_token. Valid for each shop_id, merchant_id, supplier_id, or user_id respectively, for 30 days.
expire_in
timestamp
Returned when the API call is successful. The validity period of the access_token, in seconds.
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.