stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.product.batch_publish_item_to_outlet_shop
Create asynchronous task to batch publish outlet item
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Product |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/product/batch_publish_item_to_outlet_shop |
| Production URL | https://partner.shopeemobile.com/api/v2/product/batch_publish_item_to_outlet_shop |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/product/batch_publish_item_to_outlet_shop |
| Permission | ERP System; Seller In House System; Product Management |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| item_list | object[] | Yes | The item list to batch publish to Outlet shop. The list size must be between 1 and 100. | |
| item_list.mart_item_id | int64 | Yes | The item ID of the item in the Mart shop. | |
| item_list.outlet_shop_id | int64 | Yes | The shop ID of the Outlet shop. | |
| item_list.publish_item | object | Yes | The outlet item data to publish. | |
| item_list.publish_item.outlet_item_id | int64 | No | The item ID of the item in the Outlet shop. | |
| item_list.publish_item.model | object[] | No | The outlet model list. | |
| item_list.publish_item.model.relate_mart_model_id | int64 | No | The related model ID of the product in the Mart shop. | |
| item_list.publish_item.model.model_status | string | No | The model status. | |
| item_list.publish_item.model.original_price | float | No | The original price of the outlet model. | |
| item_list.publish_item.model.seller_stock | object[] | No | The seller stock by location. | |
| item_list.publish_item.model.seller_stock.location_id | string | No | The location ID. | |
| item_list.publish_item.model.seller_stock.stock | int32 | Yes | The stock quantity of the location. | |
| item_list.publish_item.model.pre_order | object | No | The pre-order setting of the model. | |
| item_list.publish_item.model.pre_order.is_pre_order | bool | Yes | Indicate whether the model is pre-order. | |
| item_list.publish_item.model.pre_order.days_to_ship | int32 | No | The days to ship for pre-order model. | |
| item_list.publish_item.logistic_info | object[] | No | The logistic information of the outlet item. | |
| item_list.publish_item.logistic_info.logistic_id | int64 | No | The logistics channel ID used for shipping the item. | |
| item_list.publish_item.logistic_info.enabled | bool | Yes | Indicates whether the logistics channel is enabled for the item. | |
| item_list.publish_item.logistic_info.shipping_fee | float | No | The shipping fee charged to the buyer for this logistics channel. | |
| item_list.publish_item.logistic_info.size_id | int64 | No | The parcel size ID used to calculate shipping fees. | |
| item_list.publish_item.logistic_info.is_free | bool | No | Indicates whether free shipping is applied for this logistics channel. | |
| item_list.publish_item.purchase_limit_info | object | No | The purchase limit information of the outlet item. | |
| item_list.publish_item.purchase_limit_info.min_purchase_limit | int32 | No | The minimum quantity that a buyer is allowed to purchase per order. | |
| item_list.publish_item.purchase_limit_info.max_purchase_limit | object | No | The maximum purchase quantity configuration for the item. | |
| item_list.publish_item.purchase_limit_info.max_purchase_limit.purchase_limit | int32 | No | The maximum quantity that a buyer is allowed to purchase per order. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | 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. | ||
| warning | string | Indicate waring details if hit waring. Empty if no waring happened. | ||
| request_id | string | The identifier for an API request for error tracking. | ||
| response | object | |||
| response.task_id | int64 | The task ID of the batch publish outlet item task. |
§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
{
"item_list": [
{
"mart_item_id": 700001,
"outlet_shop_id": 100001,
"publish_item": {
"outlet_item_id": 200001,
"model": [
{
"relate_mart_model_id": 800001,
"original_price": 9.99,
"seller_stock": [
{
"location_id": "SGZ",
"stock": 50
}
]
},
{
"relate_mart_model_id": 800002,
"original_price": 11.99,
"seller_stock": [
{
"location_id": "SGZ",
"stock": 30
}
]
}
],
"logistic_info": [
{
"logistic_id": 50001,
"enabled": true,
"shipping_fee": 1.5,
"size_id": 0,
"is_free": false
}
],
"purchase_limit_info": {
"min_purchase_limit": 1,
"max_purchase_limit": {
"purchase_limit": 10
}
}
}
},
{
"mart_item_id": 700002,
"outlet_shop_id": 100002,
"publish_item": {
"outlet_item_id": 200002,
"model": [
{
"relate_mart_model_id": 800003,
"original_price": 13.99,
"seller_stock": [
{
"location_id": "SGZ",
"stock": 70
}
]
},
{
"relate_mart_model_id": 800004,
"original_price": 16.99,
"seller_stock": [
{
"location_id": "SGZ",
"stock": 45
}
]
}
],
"logistic_info": [
{
"logistic_id": 50001,
"enabled": true,
"shipping_fee": 1.5,
"size_id": 0,
"is_free": false
}
],
"purchase_limit_info": {
"min_purchase_limit": 1,
"max_purchase_limit": {
"purchase_limit": 5
}
}
}
}
]
}
§8 Response sample
Response sample
§9 JSON
JSON
{
"error": "",
"message": "",
"warning": "",
"request_id": "e9f2c3d4e5f6a7b8",
"response": {
"task_id": 900000003
}
}
§10 Error example
Error example
§11 JSON
JSON
{
"error": "product.error_busi",
"message": "model ID not exist in sku",
"warning": "",
"request_id": "e3e3e7f3549798db60beb2604da2f600"
}
§12 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. |
§13 Update log
Update log
| Date | Change |
|---|---|
| 2026-06-12 | New API |
