v2.product.get_kit_item_info
GET /api/v2/product/get_kit_item_info
Get the kit basic information and kit components.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/product/get_kit_item_info
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_id | int64 | True | 28001430 | ID of kit item. |
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 | Indicate waring details if hit waring. Empty if no waring happened. | |
| request_id | string | 7b9da0c6926642199c33ee9dd3a266f5 | The identifier for an API request for error tracking. |
| response | object | ||
| product_info | object | ||
| item_id | int64 | 28001430 | ID of this kit item. |
| item_name | string | item name sample | The name of this kit item. |
| category_id | int64[] | 14646 | The category of this kit item, sync from the category of the main component of this kit item. |
| item_status | string | NORMAL | Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, SELLER_DELETE, SHOPEE_DELETE, REVIEWING. |
| item_sku | string | An item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings. | |
| images | object | Item images with 1:1 ratio. | |
| image_id_list | string[] | List of image id. | |
| image_url_list | string[] | List of image url. | |
| image_ratio | string | 1:1 | 1:1 |
| long_images | object | Item images with 3:4 ratio. | |
| image_id_list | string[] | List of image id. | |
| image_url_list | string[] | List of image url. | |
| image_ratio | string | 3:4 | 3:4 |
| description_info | object | Rich text description field. Only whitelist sellers can use it. | |
| extended_description | object | If description_type is extended , Description information will be returned through this field. | |
| field_list | object[] | Field of extended description. | |
| field_type | string | Type of extended description field. See Data Definition- description_field_type (text , image). | |
| text | string | If field_type is text, text information will be returned through this field. | |
| image_info | object | If field_type is image, image will be returned through this field. | |
| image_id | string | Image id. | |
| image_url | string | Image url. | |
| description | string | If description_type is normal, description information will be returned through this field, else description will be empty. | |
| description_type | string | Type of description : values: See Data Definition- description_type (normal , extended). | |
| video_list | object | Info of video list. | |
| video_url | string | Url of video. | |
| thumbnail_url | string | Thumbnail of video. | |
| duration | int32 | Duration of video. | |
| attributes | object[] | The attributes of this kit item, sync from the attributes of the main component of this kit item. | |
| attribute_id | int64 | 4811 | The Identify of each attribute. |
| original_attribute_name | string | Brand: L2 Default [14644] | The name of each attribute. |
| attribute_value_list | object[] | ||
| value_id | int64 | 0 | Unique identifier for value of this item attribute. |
| original_value_name | string | Default | Value name of this item attribute. |
| value_unit | string | g | Value unit of this item attribute. |
| weight | string | "1.5" | The weight of this kit item, the unit is KG. |
| dimension | object | The dimension of this kit item. | |
| package_length | int32 | 11 | The length of package for this item, the unit is CM. |
| package_width | int32 | 11 | The width of package for this item, the unit is CM. |
| package_height | int32 | 11 | The height of package for this item, the unit is CM. |
| brand_info | object | The brand of this kit item, sync from the brand of the main component of this kit item. | |
| brand_id | int64 | Id of brand. | |
| original_brand_name | string | Original name of brand. | |
| model_list | object[] | Model info list, model number at most 9. | |
| model_id | int64 | ID of this kit model. | |
| model_sku | int64 | Seller SKU of this kit model. | |
| original_price | float | Original price of this kit model. | |
| tier_index | int32[] | Tier index of this kit model. | |
| component_list | object[] | ||
| component_item_id | int64 | ID of the item that composes this kit model. | |
| component_item_name | string | Name of the item that composes this kit model. | |
| component_model_id | int64 | ID of the model that composes this kit model. | |
| component_model_name | string | Name of the model that composes this kit model. | |
| quantity | int32 | The amount of the item/model that composes this kit model. | |
| main_component | boolean | Whether this item/model is the main component for this kit. | |
| component_item_or_model_image | string | ||
| component_item_or_model_sku | string | ||
| pre_order_info | object | ||
| is_pre_order | boolean | ||
| days_to_ship | int32 | ||
| tier_variation_list | object[] | Variation config of item. | |
| name | string | Variation name. | |
| option_list | object[] | Option list. | |
| option | string | Option name. | |
| image | object[] | ||
| image_id | string | Id of image. | |
| image_url | string | Url of image. |