v2.product.init_tier_variation
POST /api/v2/product/init_tier_variation
This API allows you to update the tier structure of a product. Defining only color creates one tier, while color + size creates two tiers (maximum supported). Supported changes include: no tier ↔ one/two tiers, one tier ↔ two/no tier, and two tiers ↔ one/no tier. For details, see Developer Guide. Please wait at least 5 seconds after creating an item before creating variants, as processing may be delayed.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/product/init_tier_variation
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 | 1000 | ID of item |
| model | object[] | True | Model info list, model number at most 50 | |
| tier_index | int32[] | True | [0] | Tier index of this model. If you want to update one tier/two tier to no tier, can just pass the tier_variation and standardise_tier_variation as [], and pass the model >> tier_index as [], meanwhile pass the original_price, seller_stock, etc., to set the price and stock for the modified product with no tier structure. |
| original_price | float | True | 38.3 | Original price of this model. **For CO local VAT responsible seller：**Please remember the price you set in here must be VAT inclusive. If you have any doubts on how to calculate VAT for your product please refer to the Seller Education Hub（https://seller.shopee.com.co/edu/article/13565） |
| model_sku | string | False | SKU | Seller SKU of this model, model_sku length information needs to be no more than 100 characters. |
| seller_stock | object[] | True | new stock info（Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock） | |
| location_id | string | False | location id, you can get the location id from v2.shop.get_warehouse_detail api, if seller don't have any warehouse, you don't need to upload this field. | |
| stock | int32 | True | stock | |
| gtin_code | string | False | - GTIN is an identifier for trade items, developed by the international organization GS1. - They have 8 to 14 digits. The most common are UPC, EAN, JAN and ISBN. - GTIN will help boost positioning in online marketing channels like Google and Facebook. - That incorporation with GTIN will also aid in Search and Recommendation in Shopee itself allowing buyers to have higher likelihood of finding one's listing. Note: If you want to set “Item without GTIN”, please pass the gtin_code as "00". The validation rule is based on the value return in gtin_validation_rule" field in v2.product.get_item_limit API - Mandatory: This field is required and must contain a correctly formatted GTiN number. - Flexible: This field is required and must contain either a correctly formatted GTlN number or "00" to declare that the item/model has no valid GTlN. - Optional: This field is optional and can contain a correctly formatted GTiN number, "00" or be omitted entirely. | |
| weight | float | False | 1.1 | The weight of this model, the unit is KG. If don't set the weight of this model, will use the weight of item by default. If set the dimension of this model, them must set the weight of this model. |
| dimension | object | False | The dimension of this model. If don't set the dimension of this model, will use the dimension of item by default. | |
| package_height | int32 | True | 11 | The height of package for this model, the unit is CM. |
| package_length | int32 | True | 11 | The length of package for this model, the unit is CM. |
| package_width | int32 | True | 11 | The width of package for this model, the unit is CM. |
| pre_order | object | False | Pre-order information of this model. Notes: If don't set the DTS of this model, will use the DTS of the item by default. | |
| is_pre_order | boolean | True | false | Whether the model is pre order. |
| days_to_ship | int32 | False | 2 | Days to ship. Please get the days_to_ship range from the get_dts_limit API. |
| standardise_tier_variation | object[] | False | There is at least one standardise_tier_variation and tier_variation. If you want to update one tier/two tier to no tier, can just pass the tier_variation and standardise_tier_variation as [], and pass the model >> tier_index as [], meanwhile pass the original_price, seller_stock, etc., to set the price and stock for the modified product with no tier structure. | |
| variation_id | int32 | True | 1 | standardise tier variation ID. |
| variation_name | string | False | name1 | standardise tier variation name |
| variation_group_id | int32 | False | 2 | standardise tier variation group ID |
| variation_option_list | object[] | True | standardise tier variation option list | |
| variation_option_id | int32 | False | standardise tier variation option ID. | |
| variation_option_name | string | False | option2 | standardise tier variation option value |
| image_id | string | False | 82becb4830bd2ee90ad6acf8a9dc26d7 | standardise tier variation option image ID |
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 | The identifier for an API request for error tracking | |
| response | object | ||
| item_id | int64 | 1234 | ID of item |
| tier_variation | object[] | Variations of item | |
| name | string | Color | Variation name |
| option_list | object[] | Options of this variation | |
| image | object | Image of this option | |
| image_url | string | https://cf.shopee.sg/file/82becb4830bd2ee90ad6acf8a9dc26d7 | URL of image |
| option | string | Red | Option name |
| model | object[] | ||
| tier_index | object[] | Tier index of model. Index starts from 0. | |
| model_id | int64 | 3813 | ID of model |
| model_sku | string | SKU | Seller SKU of this model |
| price_info | object[] | ||
| original_price | float | Original price | |
| seller_stock | object[] | new stock info | |
| location_id | string | location id | |
| stock | int32 | stock | |
| weight | float | 1.1 | The weight of this model, the unit is KG. If don't set the weight of this model, will use the weight of item by default. If set the dimension of this model, them must set the weight of this model. |
| dimension | object | The dimension of this model. If don't set the dimension of this model, will use the dimension of item by default. | |
| package_height | int32 | 11 | The height of package for this model, the unit is CM. |
| package_length | int32 | 11 | The length of package for this model, the unit is CM. |
| package_width | int32 | 11 | The width of package for this model, the unit is CM. |