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

v2.product.unlist_item

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.product.unlist_item

Unlist item.

#

§2 Overview

Overview

FieldValue
ModuleProduct
API typeShop
HTTP methodPOST
Path/api/v2/product/unlist_item
Production URLhttps://partner.shopeemobile.com/api/v2/product/unlist_item
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/product/unlist_item
Rate limit[0, 0, 0]
PermissionERP System; Seller In House System; Product Management; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
item_listobject[]YesLength should be between 1 to 50.
item_list.item_idint64Yes2300069665Shopee's unique identifier for an item
item_list.unlistbooleanYestrueUnlist or not
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
warningstringWarning message.
request_idstring43133476d40c400897cc8c159a214034The identifier of the API request for error tracking.
responseobject
response.failure_listobject[]
response.failure_list.item_idint642300069665Failed item id
response.failure_list.failed_reasonstringCan't unlist item when item is under promotionFailed reason
response.success_listobject[]
response.success_list.item_idint642400143710Success item id
response.success_list.unlistbooleanfalseWhether the item is unlisted
#

§5 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.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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

{
    "item_list": [
        {
            "item_id": 2300069665,
            "unlist": true
        },
        {
            "item_id": 2400143710,
            "unlist": false
        }
    ]
}
#

§8 Response sample

Response sample

#

§9 JSON

JSON

{
    "error": "",
    "message": "",
    "warning": "",
    "request_id": "43133476d40c400897cc8c159a214034",
    "response": {
        "failure_list": [
            {
                "item_id": 2300069665,
                "failed_reason": "Can't unlist item when item is under promotion"
            }
        ],
        "success_list": [
            {
                "item_id": 2400143710,
                "unlist": false
            }
        ]
    }
}
#

§10 Error example

Error example

#

§11 JSON

JSON

{
    "error": "product.error_param",
    "message": "invalid field ItemList: value must  Not Null",
    "request_id": "25d1940b7057f5f6c78ac671d6af97d0"
}
#

§12 Errors

Errors

ErrorDescriptionSolution
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_shopshopid is invalid
error_paramrequest not from gateway
error_authcnsc shop not upgraded, can not edit item.
error_param_shop_id_not_foundShop_id is not found.
error_unlist_item_all_failedUnlist item all failed.
error_unlist_item_failedUnlist item failed. please try later.
error_get_shop_failGet shop failed. please try later.
error_busi_invalid_shop_statusShop status invalid.
error_innerOur system is taking some time to respond, please try later.
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_item_not_foundProduct not found
error_innerUpdate item failed {{.error_info}}
error_innerUpdate item failed {{.error_info}}
error_unlist_item_failPlease upload your products to UNLIST status. Products will be published automatically by Shopee at the official launch date.
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_busi_cannot_delist_reviewing_or_banned_itemBanned and Reviewing Products cannot be delisted
error_busi_cannot_edit_vskuCan not use OpenAPI to edit/create VSKU, please connect with your manager
error_authYour shop can not use model level dts
error_authThe registered phone number of your shop is abnormal (Malaysian phone number was detected), please update the phone number immediately.
error_system_busyOur system is taking some time to respond, please try later.
error_nil_item_in_reqInteral error, please contact openapi team.
error_set_normal_unlisted_itemCannot change unlisted item status to normal directly, need to publishdelisted item first.
error_unlist_item_failedUnlist item failed. plaese try later.
error_cannt_unlisted_in_promotionItem cannot be unlisted when item is under promotion.
error_in_item_promotion_unlsit_lockCan't unlist item when item is under promotion.
error_unlist_in_promotionCannot unlist item when item is under promotion.
#

§13 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.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#