Skip to main content

v2.product.update_kit_item

POST /api/v2/product/update_kit_item

Update the kit basic information and kit components, only support adding kit variations and updating existing kit variation’s image, price, and model_sku, don’t support deleting existing kit variations and updating the items, main component and quantity per kit of existing kit variations.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/product/update_kit_item

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.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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

NameTypeRequiredSampleDescription
item_idint64True28001430ID of kit item.
item_settingobjectFalse
item_namestringFalseitem name sampleThe name of this kit item.
imagesobjectFalseItem images with 1:1 ratio.
image_id_liststring[]TrueID of image.
long_imagesobjectFalseItem images with 3:4 ratio.
image_id_liststring[]TrueID of image.
video_upload_idstring[]False["sg_f4bde9bc-ff3c-485e-a6dd-3161dab4b942_000000"]Video upload ID returned from video uploading API. Only accept one video_upload_id.
descriptionstringFalseitem description sampleIf description_type is normal, description information should be set by this field.
description_infoobjectFalseRich 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_descriptionobjectTrueIf description_type is extended , Description information should be set by this field.
field_listobject[]TrueField of extended description.
field_typestringTrueType of extended description field. See Data Definition- description_field_type (text , image).
textstringTrueIf field_type is text, text information will be set by this field.
image_infoobjectFalseIf field_type is image, image will be set by this field.
image_idstringTrueImage id.
description_typestringFalseextendedSee Data Definition- description_type (normal , extended). If you want to use extended_description, this field must be inputed.
logistic_infoobject[]FalseLogistic channel setting.
logistic_idint64TrueID of the channel.
enabledbooleanTrueWhether channel is enabled for this kit item.
shipping_feefloatFalseShipping fee. Only needed when logistics fee_type = CUSTOM_PRICE.
size_idint64FalseSize ID. Only needed when logistic fee_type = SIZE_SELECTION.
is_freebooleanFalseWhether cover shipping fee for buyer.
unlistedbooleanFalsefalseUnlist or not.
item_skustringFalseitem sku sampleSKU tag of item
weightfloatFalse1.1The weight of this kit item, the unit is KG.
dimensionobjectFalseThe dimension of this kit item.
package_lengthint32True11The length of package for this kit item, the unit is CM.
package_widthint32True11The width of package for this kit item, the unit is CM.
package_heightint32True11The height of package for this kit item, the unit is CM.
pre_orderobjectFalsePre order setting.
is_pre_orderbooleanTruefalseWhether kit item is pre order.
days_to_shipint64False10The guaranteed days to ship orders. Please get the days_to_ship range from get_kit_item_limit api.
model_listobject[]FalseModel info list, model number at most 9.
model_idint64False1002066586922ID of this kit model.
tier_indexint64[]True[2]Tier index of this kit model.
model_skustringFalsemodel sku sampleSeller SKU of this kit model, model_sku length information needs to be no more than 100 characters.
original_pricefloatFalse38.3Original price of this kit model.
component_listobject[]FalsePlease get the amount of item/model that one kit model support from get_kit_item_limit.
component_item_idint64True892568916ID of the item that composes this kit model.
component_model_idint64False8501462426ID of the model that composes this kit model.
quantityint64True2The amount of the item/model that composes this kit model.
main_componentbooleanFalsefalseWhether this item/model is the main component for this kit. One kit item can only have one item/model as main component.
tier_variation_listobject[]FalseTier variation info list. Only support one tier variation, and each kit item can have from 1 to 9 kit variations.
namestringFalseTier variation name.
option_listobject[]TrueTier variation option info list.
optionstringTrueOption name.
imageobjectFalseOption image.
image_idstringTrueID of image. If you choose to define, you need to define an image for all options.
sync_settingobjectFalse
auto_sync_dtsbooleanTrueAuto sync the pre_order setting from main component or not.

Response Parameters

NameTypeSampleDescription
errorstring
messagestring
warningstring
request_idstring