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
| 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 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| global_item_id | int64 | True | 3500140268 | Id of global item. |
| shop_id | int32 | True | 600620392 | Id of shop to publish to. |
| shop_region | string | True | TW | Region of shop. |
| item | object | False | Item information. | |
| item_name | string | False | 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. |
| description | string | False | 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_status | string | False | NORMAL | Status of item. |
| original_price | float | False | 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. |
| image | object | False | Image information of item. | |
| image_id_list | string[] | True | ["c54265d475b85e00ffb2404585e32b6f"] | Image id list of item. |
| model | object[] | False | Model information of item. | |
| tier_index | int32[] | True | [0, 0] | Tier index of model. |
| original_price | float | True | 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. |
| model_status | string | False | 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". |
| size_chart | string | False | 591ab15ea954b9879374765854595600 | Size chart of item. Only support image_id for now |
| logistic | object[] | False | Logistic information of item. | |
| logistic_id | int32 | True | 1001 | Logistic id. |
| enabled | boolean | True | true | If this logistic channel is enabled. |
| shipping_fee | float | False | 10.5 | Shipping fee. |
| size_id | int32 | False | 10 | Size id. |
| is_free | boolean | False | false | If this logistic channel is free. |
| pre_order | object | False | Preorder information of item. | |
| is_pre_order | boolean | True | true | If this item is preorder. |
| days_to_ship | int32 | False | 3 | Days to ship, it's mandatory if is_pre_order is true. |
| description_info | object | False | 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. | |
| extended_description | object | False | If description_type is extended , Description information should be set by this field. | |
| field_list | object[] | False | Field of extended description. | |
| field_type | string | False | Type of extended description field :values: See Data Definition- description_field_type (text , image). | |
| text | string | False | If field_type is text, text information will be set by this field. | |
| image_info | object | False | If field_type is image,image url will be set by this field. | |
| image_id | string | False | Image id. | |
| standardise_tier_variation | object[] | False | ||
| variation_id | int | False | ||
| variation_name | string | False | ||
| variation_group_id | int | False | ||
| variation_option_list | object[] | False | ||
| variation_option_id | int | False | ||
| variation_option_name | string | False | ||
| image_id | string | False |
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 | ||
| publish_task_id | int64 | 202011300000012008 | The 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" } ] } } } }