Skip to main content

v2.global_product.create_publish_task

POST /api/v2/global_product/create_publish_task

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

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/global_product/create_publish_task

Common Request Parameters

NameTypeSampleDescription
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.
merchant_idint1Shopee’s unique identifier for a merchant. Required for all merchant level requests(CB CNSC user calling global product related APIs).
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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

Request Parameters

NameTypeRequiredSampleDescription
global_item_idint64True3500140268Id of global item.
shop_idint32True600620392Id of shop to publish to.
shop_regionstringTrueTWRegion of shop.
itemobjectFalseItem information.
item_namestringFalseitem nameName 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.
descriptionstringFalseitem descriptionDescription 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_statusstringFalseNORMALStatus of item.
original_pricefloatFalse100.5Original 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.
imageobjectFalseImage information of item.
image_id_liststring[]True["c54265d475b85e00ffb2404585e32b6f"]Image id list of item.
modelobject[]FalseModel information of item.
tier_indexint32[]True[0, 0]Tier index of model.
original_pricefloatTrue100.5Original 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.
model_statusstringFalseNORMALcan 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".
size_chartstringFalse591ab15ea954b9879374765854595600Size chart of item. Only support image_id for now
logisticobject[]FalseLogistic information of item.
logistic_idint32True1001Logistic id.
enabledbooleanTruetrueIf this logistic channel is enabled.
shipping_feefloatFalse10.5Shipping fee.
size_idint32False10Size id.
is_freebooleanFalsefalseIf this logistic channel is free.
pre_orderobjectFalsePreorder information of item.
is_pre_orderbooleanTruetrueIf this item is preorder.
days_to_shipint32False3Days to ship, it's mandatory if is_pre_order is true.
description_infoobjectFalseNew 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.
extended_descriptionobjectFalseIf description_type is extended , Description information should be set by this field.
field_listobject[]FalseField of extended description.
field_typestringFalseType of extended description field :values: See Data Definition- description_field_type (text , image).
textstringFalseIf field_type is text, text information will be set by this field.
image_infoobjectFalseIf field_type is image,image url will be set by this field.
image_idstringFalseImage id.
standardise_tier_variationobject[]False
variation_idintFalse
variation_namestringFalse
variation_group_idintFalse
variation_option_listobject[]False
variation_option_idintFalse
variation_option_namestringFalse
image_idstringFalse

Response Parameters

NameTypeSampleDescription
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_idstring369c79e9a42147f6912e2bf21c96ba23The identifier of the API request for error tracking.
responseobject
publish_task_idint64202011300000012008The id of publish task.

, "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" } ] } } } }