v2.global_product.create_publish_task

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.global_product.create_publish_task

Create publish task for global item. Only for China mainland sellers and Korean sellers.

§2 Overview

Overview

Field	Value
Module	GlobalProduct
API type	Merchant
HTTP method	POST
Path	/api/v2/global_product/create_publish_task
Production URL	https://partner.shopeemobile.com/api/v2/global_product/create_publish_task
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/global_product/create_publish_task
Rate limit	[0, 0, 0]
Permission	ERP System; Seller In House System; Product Management

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
global_item_id	int64	Yes	3500140268	Id of global item.
shop_id	int32	Yes	600620392	Id of shop to publish to.
shop_region	string	Yes	TW	Region of shop.
item	object	No		Item information.
item.item_name	string	No	item name	Name of item. If you upload this field, we will take your value, so you should pass the value in the local language, if you don't upload this field, Shopee will automatically translate your global product name into the local language.
item.description	string	No	item description	Description of item. If you upload this field, we will take your value, so you should pass the value in the local language, if you don't upload this field, Shopee will automatically translate your global product description into the local language.
item.item_status	string	No	NORMAL	Status of item.
item.original_price	float	No	100.5	Original price of item.; For SG/MY/BR/MX/PL/ES/AR seller: Sellers can set the price with two decimal place, other regions can only set the price as an integer. If you upload this field, we will take your value, so you should pass the value in local currency, if you don't upload this field, Shopee will automatically calculate the price.
item.image	object	No		Image information of item.
item.image.image_id_list	string[]	Yes	["c54265d475b85e00ffb2404585e32b6f"]	Image id list of item.
item.model	object[]	No		Model information of item.
item.model.tier_index	int32[]	Yes	[0, 0]	Tier index of model.
item.model.original_price	float	Yes	100.5	Original price of model. If you upload this field, we will take your value, so you should pass the value in local currency, if you don't upload this field, Shopee will automatically calculate the price.
item.model.model_status	string	No	NORMAL	can be "NORMAL" or "UNAVAILABLE". Normal models can be sold on the buyer's side, and UNAVAILABLE models cannot be sold on the buyer's side. If you do not upload this field, the model status will be considered as "NORMAL".
item.size_chart	string	No	591ab15ea954b9879374765854595600	Size chart of item. Only support image_id for now
item.logistic	object[]	No		Logistic information of item.
item.logistic.logistic_id	int32	Yes	1001	Logistic id.
item.logistic.enabled	boolean	Yes	true	If this logistic channel is enabled.
item.logistic.shipping_fee	float	No	10.5	Shipping fee.
item.logistic.size_id	int32	No	10	Size id.
item.logistic.is_free	boolean	No	false	If this logistic channel is free.
item.pre_order	object	No		Preorder information of item.
item.pre_order.is_pre_order	boolean	Yes	true	If this item is preorder.
item.pre_order.days_to_ship	int32	No	3	Days to ship, it's mandatory if is_pre_order is true.
item.description_info	object	No		New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal. If you upload this field, we will take your value, so you should pass the value in the local language, if you don't upload this field, Shopee will automatically translate your global product description into the local language.
item.description_info.extended_description	object	No		If description_type is extended , Description information should be set by this field.
item.description_info.extended_description.field_list	object[]	No		Field of extended description.
item.description_info.extended_description.field_list.field_type	string	No		Type of extended description field ：values: See Data Definition- description_field_type (text , image).
item.description_info.extended_description.field_list.text	string	No		If field_type is text， text information will be set by this field.
item.description_info.extended_description.field_list.image_info	object	No		If field_type is image，image url will be set by this field.
item.description_info.extended_description.field_list.image_info.image_id	string	No		Image id.
item.standardise_tier_variation	object[]	No
item.standardise_tier_variation.variation_id	int	No
item.standardise_tier_variation.variation_name	string	No
item.standardise_tier_variation.variation_group_id	int	No
item.standardise_tier_variation.variation_option_list	object[]	No
item.standardise_tier_variation.variation_option_list.variation_option_id	int	No
item.standardise_tier_variation.variation_option_list.variation_option_name	string	No
item.standardise_tier_variation.variation_option_list.image_id	string	No

§4 Response parameters

Response parameters

Name	Type	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		Warning message.
request_id	string	369c79e9a42147f6912e2bf21c96ba23	The identifier of the API request for error tracking.
response	object
response.publish_task_id	int64	202011300000012008	The id of publish task.

§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.
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.
merchant_id	int	1	Shopee’s unique identifier for a merchant. Required for all merchant level requests(CB CNSC user calling global product related APIs).
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, merchant_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

{
    "global_item_id": 3500140268,
    "shop_id": 600620392,
    "shop_region": "TW",
    "item": {
        "item_name": "item name",
        "description": "item description",
        "item_status": "NORMAL",
        "original_price": 100.5,
        "image": {
            "image_id_list": [
                "c54265d475b85e00ffb2404585e32b6f"
            ]
        },
        "category_id": 7535,
        "standardise_tier_variation": [
            {
                "variation_id": 0,
                "variation_name": "Size",
                "variation_option_list": [
                    {
                        "image_id": "br-11134207-7r98o-m8s1833s61he9a",
                        "image_url": "https://cf.shopee.com.br/file/br-11134207-7r98o-m8s1833s61he9a",
                        "variation_option_id": 0,
                        "variation_option_name": "S"
                    },
                    {
                        "image_id": "br-11134207-7r98o-m8s1833s7g1u9a",
                        "image_url": "https://cf.shopee.com.br/file/br-11134207-7r98o-m8s1833s7g1u9a",
                        "variation_option_id": 0,
                        "variation_option_name": "M"
                    }
                ]
            }
        ],
        "model": [
            {
                "tier_index": [
                    0,
                    0
                ],
                "original_price": 100.5
            },
            {
                "tier_index": [
                    0,
                    1
                ],
                "original_price": 101.5
            },
            {
                "tier_index": [
                    1,
                    0
                ],
                "original_price": 110.5
            },
            {
                "tier_index": [
                    1,
                    1
                ],
                "original_price": 120.5
            }
        ],
        "size_chart": "591ab15ea954b9879374765854595600",
        "logistic": [
            {
                "logistic_id": 1001,
                "enabled": true,
                "shipping_fee": 10,
                "size_id": 10,
                "is_free": false
            }
        ],
        "pre_order": {
            "is_pre_order": true,
            "days_to_ship": 3
        },
        "description_info": {
            "extended_description": {
                "field_list": [
                    {
                        "field_type": "text",
                        "text": "text description 1"
                    },
                    {
                        "field_type": "image",
                        "image_info": {
                            "image_id": "1e076dff0699d8e778c06dd6c02df1fe"
                        }
                    },
                    {
                        "field_type": "image",
                        "image_info": {
                            "image_id": "c07ac95ba7bb624d731e37fe2f0349de"
                        }
                    },
                    {
                        "field_type": "text",
                        "text": "text description 1"
                    }
                ]
            }
        }
    }
}

§8 Response sample

Response sample

§9 JSON

JSON

{
    "error": "",
    "message": "",
    "warning": "",
    "request_id": "369c79e9a42147f6912e2bf21c96ba23",
    "response": {
        "publish_task_id": 202011300000012008
    }
}

§10 Error example

Error example

§11 JSON

JSON

{
  "message": "Publish failed,  shop is on holiday.",
  "request_id": "2250754ff2162bcb803c17ad2ac1c22c",
  "error": "error_busi_cannot_publish."
}

§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_param	request not from gateway
error_auth	partner does not have permission to operate shop
error_auth	can not publish product to sip affiliated shop
error_auth	shop is not upgraded or lack service fee rate
error_item_not_found	Item_id is not found.
error_merchant_not_found	Merchant_id is not found.
error_param	Partner_id is not found.
error_param	Parameter is not match the constraints, {{.error_info}}.
error_get_shop_fail	Get shop failed. please try later.
error_busi_global_item_not_found	Global item not found.
error_busi_cannot_publish	Publish failed, {{.error_info}}.
error_inner	Our system is taking some time to respond, please try later.
error_inner	System error, please try again later or contact the OpenAPI support team.
error_check_language_fail	check language fail, {{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_check_luc_fail	{{.error_info}}
error_category_is_block	Category is restricted
error_inner	Update item failed {{.error_info}}
error_inner	Update item failed {{.error_info}}
error_param	Attribute format is invalid. NCC field only allows Eng Alphanumeric input
error_inner	System error, please try again later or contact the OpenAPI support team.
error_inner	System error, please try again later or contact the OpenAPI support team.
error_desc_image_no_pass	{{.error_info}}
error_desc_image_no_pass	{{.error_info}}
error_desc_image_no_pass	{{.error_info}}
error_desc_image_no_pass	{{.error_info}}
error_auth	Your shop can not use model level dts
error_param	{{.error_info}}
error_desc_image_no_pass	{{.error_info}}
error_desc_image_no_pass	{{.error_info}}
error_desc_image_no_pass	{{.error_info}}
error_desc_image_no_pass	{{.error_info}}
error_param	{{.error_info}}
error_system_busy	Our system is taking some time to respond, please try later.

§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.
merchant_no_linked	Partner and merchant has no linked.
invalid_acceess_token	Invalid access_token, please have a check.
partner_frozen	The Partner has been frozen. Permissions for merchant authorization and API calls have been suspended until permissions are restored.
error_param	There is no merchant_id in query.
error_param	merchant_id is invalid, should be an integer between 0 and 4294967295.

§14 Update log

Update log

Date	Change
2025-09-15	The tier_variation structure in the documentation has been deprecated. Please use the standardise_tier_variation structure when uploading variations.
2023-01-03	add model_status field
2022-07-26	update the description
2022-06-17	remove category id
2022-02-22	update

这条内容对你有帮助吗？