v2.product.add_kit_item

POST /api/v2/product/add_kit_item

Create the kit item by selecting multiple items and setting main component and quantity per kit.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/product/add_kit_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.
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

Request Parameters

Name	Type	Required	Sample	Description
item_setting	object	True
item_name	string	True	item name sample	The name of this kit item.
images	object	True		Item images with 1:1 ratio.
image_id_list	string[]	True		ID of image.
long_images	object	False		Item images with 3:4 ratio.
image_id_list	string[]	True		ID of image.
video_upload_id	string[]	False	["sg_f4bde9bc-ff3c-485e-a6dd-3161dab4b942_000000"]	Video upload ID returned from video uploading API. Only accept one video_upload_id.
description	string	False	item description sample	If description_type is normal, description information should be set by this field.
description_info	object	False		Rich text 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	True		If description_type is extended , Description information should be set by this field.
field_list	object[]	True		Field of extended description.
field_type	string	True		Type of extended description field. See Data Definition- description_field_type (text , image).
text	string	True		If field_type is text, text information will be set by this field.
image_info	object	False		If field_type is image, image will be set by this field.
image_id	string	True		Image id.
description_type	string	True	extended	See Data Definition- description_type (normal , extended). If you want to use extended_description, this field must be inputed.
logistic_info	object[]	True		Logistic channel setting.
logistic_id	int64	True		ID of the channel.
enabled	boolean	True		Whether channel is enabled for this kit item.
shipping_fee	float	False		Shipping fee. Only needed when logistics fee_type = CUSTOM_PRICE.
size_id	int64	False		Size ID. Only needed when logistic fee_type = SIZE_SELECTION.
is_free	boolean	False		Whether cover shipping fee for buyer.
unlisted	boolean	False	false	Unlist or not.
item_sku	string	False	item sku sample	SKU tag of item
weight	float	True	1.1	The weight of this kit item, the unit is KG.
dimension	object	False		The dimension of this kit item.
package_length	int32	True	11	The length of package for this kit item, the unit is CM.
package_width	int32	True	11	The width of package for this kit item, the unit is CM.
package_height	int32	True	11	The height of package for this kit item, the unit is CM.
pre_order	object	False		Pre order setting.
is_pre_order	boolean	True	true	Whether kit item is pre order.
days_to_ship	int32	False	10	The guaranteed days to ship orders. Please get the days_to_ship range from get_kit_item_limit api.
model_list	object[]	True		Model info list, model number at most 9.
tier_index	int32[]	True	[0]	Tier index of this kit model.
model_sku	string	False	model sku sample	Seller SKU of this kit model, model_sku length information needs to be no more than 100 characters.
original_price	float	True	38.3	Original price of this kit model.
component_list	object[]	True		Please get the amount of item/model that one kit model support from get_kit_item_limit.
component_item_id	int64	True	892568916	ID of the item that composes this kit model.
component_model_id	int64	False	8501462426	ID of the model that composes this kit model.
quantity	int32	True	2	The amount of the item/model that composes this kit model.
main_component	boolean	False	true	Whether this item/model is the main component for this kit. One kit item can only have one item/model as main component.
tier_variation_list	object[]	True		Tier variation info list. Only support one tier variation, and each kit item can have from 1 to 9 kit variations.
name	string	False		Tier variation name.
option_list	object[]	True		Tier variation option info list.
option	string	True		Option name.
image	object	False		Option image.
image_id	string	True		ID of image. If you choose to define, you need to define an image for all options.
sync_setting	object	False
auto_sync_dts	boolean	True	true	Auto sync the pre_order setting from main component or not.

Response Parameters

Name	Type	Sample	Description
error	string
message	string
warning	string
request_id	string
response	object
item_id	int64