v2.product.get_item_list

GET /api/v2/product/get_item_list

Use this call to get a list of items.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/product/get_item_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
offset	int64	True	0	Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call.
page_size	int64	True	10	the size of one page.Max=100
update_time_from	timestamp	False	1611311600	The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_from field is the starting date range.
update_time_to	timestamp	False	1611311631	The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_to field is the ending date range
item_status	string[]	True	["NORMAL"]	NORMAL/BANNED/UNLIST/REVIEWING/SELLER_DELETE/SHOPEE_DELETE If you want to search multiple status, please upload the url like this: item_status=NORMAL&item_status=BANNED

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
item	object[]		list of item info with item_id/ item_status/ update_time
item_id	int64	2500139861	Shopee's unique identifier for an item.
item_status	string	NORMAL	Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE.
update_time	timestamp	1608128470	The update time of item.
tag	object
kit	boolean	true	Indicate if the item is kit item.
total_count	int64	10	total count of all items
has_next_page	boolean	true	This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
next_offset	int64	10	if has_next_page is true, this value need set to next request.offset