v2.product.get_model_list

GET /api/v2/product/get_model_list

Get model list of an item.

Endpoint URL

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

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	178312	The ID of the item

Response Parameters

Name	Type	Sample	Description
message	string		Indicate error details if hit error. Empty if no error happened.
warning	string		Warning message.
request_id	string	75c2b01e50764cec8cfdc61e75c1f26d	The identifier for an API request for error tracking.
response	object
tier_variation	object[]		Variation config of item.
option_list	object[]		Option list.
option	string	testsku1	Option name.
image	object
image_id	string		Id of image
image_url	string		Url of image.
name	string		Variation name.
model	object[]		Model list.
price_info	object[]		Price info. For SG/MY/BR/MX/PL/ES/AR seller: Sellers can set the price with two decimal place, other regions can only set the price as an integer.
currency	string	TWD	Currency for the item price.
current_price	float	100.0	Current price of item.
original_price	float	100.0	Original price of item.
inflated_price_of_original_price	float	100.0	Original price of item after tax.
inflated_price_of_current_price	float	100.0	Current price of item after tax.
sip_item_price	float	100.0	SIP item price. If item is from SIP primary shop, this field will be returned.
sip_item_price_source	string	manual	SIP item price source, could be manual or auto.If item is from SIP primary shop, this field will be returned.
sip_item_price_currency	string	CNY	The currency of sip_item_price.If item is from SIP primary shop, this field will be returned.
local_price	float	122.02	The original price multiplied by the local adjustment rate equals the local price. The local price is denominated in the local currency and is rounded to two decimal places. <path></path>
local_promotion_price	float	122.02	During the promotion period, the CB price is multiplied by the local adjustment rate. Once the promotion starts, the price remains unchanged. During the promotion, the local_promotion_price= current_price, which is denominated in the local currency and retained to two decimal places. <path></path>
model_id	int64	2000458802	Model ID.
tier_index	int32[]	[0, 1]	Tier index of this model.
promotion_id	int64	0	Current promotion ID of this model.
has_promotion	boolean	true	Indicates whether the model is currently under any ongoing promotion.
model_sku	string	blue bag	SKU of this model. the length should be under 100.
model_status	string	MODEL_NORMAL	The model status. Should be MODEL_NORMAL or MODEL_UNAVAILABLE. MODEL_NORMAL models can be sold on the buyer's side, and MODEL_UNAVAILABLE models cannot be sold on the buyer's side.
pre_order	object		(Only whitelisted users can use)
is_pre_order	boolean	false	Pre-order.
days_to_ship	int32	3	The days to ship.
stock_info_v2	object		new stock info. Please check this FAQ for more detail: https://open.shopee.com/faq?top=162&sub=166&page=1&faq=230
summary_info	object		stock summary Info
total_reserved_stock	int32		Stock reserved for promotion. Note: For SIP P Item, will return the total reserved stock for P Item and all A Items under the P Item.
total_available_stock	int32		Stock can be sold currently
seller_stock	object[]		Seller-managed stock
location_id	string		location id
stock	int32		stock in the current warehouse
if_saleable	boolean	true	To return if the stock of the location id is saleable
shopee_stock	object[]		Shopee warehouse stock
location_id	string		location id
stock	string		stock
advance_stock	object		Only for PH/VN/ID/MY local selected shops.
sellable_advance_stock	int32		Refers to Advance Fulfillment stock that Seller has shipped out and is available to be used to fulfill an order.
in_transit_advance_stock	int32		Refers to Advance Fulfillment stock that seller has shipped out and is still in transit and unavailable to be used to fulfill an order.
gtin_code	string		(Only TW seller and BR local seller available) gtin code.
weight	string	"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.
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.
is_fulfillment_by_shopee	boolean		whether model is fulfillment by shopee
standardise_tier_variation	object[]		Standardise Variation config of item.
variation_id	int64		Standardise Variation ID
variation_name	string		Standardise Variation Name
variation_group_id	int64		Standardise Variation Group ID
variation_option_list	object[]		Standardise Variation Option List
variation_option_id	int64		Standardise Option ID
variation_option_name	string		Standardise Option Name
image_id	string		ID of image
image_url	string		URL of image
error	string		Indicate error type if hit error. Empty if no error happened.