stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.shop_category.update_shop_category
Use this call to update a existing collecion
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | ShopCategory |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/shop_category/update_shop_category |
| Production URL | https://partner.shopeemobile.com/api/v2/shop_category/update_shop_category |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/shop_category/update_shop_category |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Product Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| shop_category_id | int | Yes | 29333 | ShopCategory's unique identifier. |
| name | string | No | OA_V2_11 | ShopCategory's name. |
| sort_weight | int | No | 21 | ShopCategory's sort weight. |
| status | string | No | NORMAL | ShopCategory's status. Applicable values: NORMAL, INACTIVE, DELETED. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| request_id | string | 062afea7ca7c225a7966b5bf97570bc1 | The identifier of the API request for error tracking | |
| error | string | The name of the error raised in the request. The error will be empty if the request succeeds. | ||
| message | string | The detailed description of the error. The message will be empty if the request succeeds. | ||
| response | object | |||
| response.shop_category_id | int | 29333 | This is to indicate whether the shop categories list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of shop categories | |
| response.name | string | OA_V2_11 | ShopCategory's name. | |
| response.sort_weight | int | 21 | ShopCategory's sort weight. | |
| response.status | string | NORMAL | ShopCategory's status. Applicable values: NORMAL, INACTIVE, DELETED. |
§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
/api/v2/shop_category/update_shop_category?partner_id=844248&shop_id=220286625×tamp=1610678061
{
"shop_category_id": 29333,
"name": "OA_V2_11",
"status": "NORMAL"
}
§8 Response sample
Response sample
§9 JSON
JSON
{
"message": "",
"error": "",
"response": {
"status": "NORMAL",
"shop_category_id": 29333,
"sort_weight": 21,
"name": "OA_V2_11"
},
"request_id": "062afea7ca7c225a7966b5bf97570bc1"
}
§10 Error example
Error example
§11 JSON
JSON
{
"request_id": "6f6985d9808a9f5ed49a61a81be6dbb0",
"error": "error_auth",
"message": "Invalid partner_id or shopid."
}
§12 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. | |
| error_shop | shopid is invalid | |
| error_param | request not from gateway | |
| error_param | The maximum number of the toggle-on customized category cannot exceed 100. | |
| error_param | Shopee 24 category cannot edit the name and sort_weight. | |
| error_service | Unknown error, please contact developer. | |
| error_service | The shop category id is not found. | |
| error_param | ShopCategory name length cannot exceed 40 characters. | |
| error_param | Sort_weight should be between [0, 2147483546]. | |
| error_param | ShopCategory name is duplicated. | |
| error_param | ShopCategory name should not be empty. | |
| error_param | Nothing changes on the shop category update operation. | |
| error_auth | You have no valid partnerid. | |
| error_param | Syntax error. Please check the format of your Request Parameter. | |
| error_param | Wrong parameters, detail: {msg} | |
| error_param | This shop category doesn't exist. | |
| error_param | Shop is not found. | |
| error_param | The maximum number of the toggle-on Shopee category cannot exceed 50. | |
| error_param | ShopCategory's status can only be: NORMAL, INACTIVE, DELETED. |
§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 |
|---|---|
| 2022-07-27 | Add Error Example information |
| 2022-07-01 | Optimize the Sample information of Request Parameter and Response Parameter |
