v2.global_product.add_global_item

POST /api/v2/global_product/add_global_item

Add global item. Only for China mainland sellers using China Seller Centre(CNSC). More details in https://shopee.cn/cooperate/46/53/926.

Endpoint URL

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

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
category_id	int64	True	14695	Category id of global item.
global_item_name	string	True	item name sample	Name of global item.
description	string	True	item description sample	Description of global item.
global_item_sku	string	False	item sku sample	Sku of global item.
image	object	False		Image information of global item.
image_id_list	string[]	True	["c54265d475b85e00ffb2404585e32b6f", "6fb33d484f232510b5f9b169f2758322"]	Image id list of global item.
original_price	float	True	95.5	Original price of global item.
normal_stock	int64	False	100	Normal stock of global item.
weight	float	True	100.5	Weight of global item.
dimension	object	False		Dimension information of global item.
package_length	int64	True	11	Package length of global item.
package_width	int64	True	11	Package width of global item.
package_height	int64	True	11	Package height of global item.
pre_order	object	True		Preorder information of global item.
days_to_ship	int64	True	3	Days to ship.
condition	string	False	NEW	Condition of global item, "NEW" or "USED" is available.
video_upload_id	string[]	False	["00a2258551b5a2f0a7c283f877330f93"]	Video upload id of global item. Only accept one video_upload_id at most.
brand	object	False
brand_id	int64	False	1078	Id of brand.
original_brand_name	string	False	Nike	Original name of brand.
attribute_list	object[]	False		Item attributes.
attribute_id	int64	False	1007105	ID of attribute.
attribute_value_list	object[]	False
value_id	int64	False	38173	ID of attribute value. In the following cases, the value id needs to be uploaded as 0, and original_value_name is mandatory, needs to be filled in customized value. (1) AttributeInputType is TEXT_FILED; (2) AttributeInputType is COMBO_BOX or MULTIPLE_SELECT_COMBO_BOX, and the seller want to fill in a customized value.
original_value_name	string	False	Red	Name of attribute value. original_value_name from global_product.get_attributes api. If value id=0, this field is required. If AttributeType is DATE_TYPE or TIMESTAMP_TYPE, you can upload timestamp(string type) as the original_value_name.
value_unit	string	False	kg	Unit of attribute value.(quantitative attribute only)
description_info	object	False		New description field. 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
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.
description_type	string	False		Values: See Data Definition- description_type (normal , extended). If you want to use extended_description, this field must be inputed
seller_stock	object[]	False		seller_stock of global item.
location_id	string	False	CNZ	location_id of stock
stock	int32	True	100	stock
ds_cat_rcmd_id	string	False		category recommendation service id
size_chart_info	object	False
size_chart	string	False		ID of size chart image. If you want to remove the image size chart of the item, please pass the "size_chart" empty. You only need to fill out either the image or template. If both are filled, only the template will be kept. Notes: Both CB shops and local shops are supported to set "size_chart".
size_chart_id	int64	False		ID of template size chart. If you want to remove the template size chart of the item, please pass the "size_chart_id" as 0. You only need to fill out either the image or template. If both are filled, only the template will be kept. Notes: Both local shops and CB shops are supported to set "size_chart_id" now and seller need set the size_chart template in CBSC in advance

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	98eae35efff24dd0974c21a847127184	The identifier for an API request for error tracking.
response	object
global_item_id	int64	1007962	Id of added global item.

}, "brand":{ "brand_id":1078, "original_brand_name":"Nike" }, "category_id":14695, "condition":"NEW", "description":"item description sample", "description_info":{ "extended_description":{ "field_list":{ "field_type":"", "image_info":{ "image_id":"" }, "text":"" } } }, "description_type":"", "dimension":{ "package_height":11, "package_length":12, "package_width":13 }, "global_item_name":"item name sample", "global_item_sku":"item sku sample", "image":{ "image_id_list":"["c54265d475b85e00ffb2404585e32b6f", "6fb33d484f232510b5f9b169f2758322"]" }, "normal_stock":100, "original_price":95.5, "pre_order":{ "days_to_ship":3 }, "video_upload_id":"["00a2258551b5a2f0a7c283f877330f93"]", "weight":100.5, "seller_stock":[ { "location_id":"CNZ", "stock":100 } ] }

No Response Example Set.