Available Shopee APIs

Naga Sri Hari Gonaboyina

Updated November 25, 2024 17:22

When you configure an export, import, or other type of flow step using the prebuilt Shopee connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Shopee API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Accounthealth	Get shop penalty	X
Accounthealth	Get shop performance	X
Add-on deal	Get add-on deal list	X
	Get add-on deal	X
	Get add-on deal sub item	X
	Get add-on deal main item	X
	Add add-on deal		X
	Add add-on deal main item		X
	Add add-on deal sub item		X
	Delete add-on deal		X
	Delete add-on deal main item		X
	Delete add-on deal sub item		X
	Update add-on deal		X
	Update add-on deal main item		X
	Update add-on deal sub item		X
	End add-on deal		X
Bundle deal	Get bundle deal list	X
	Get bundle deal detail	X
	Get bundle deal item	X
	Create bundle deal		X
	Add product to bundle deal		X
	Update bundle deal		X
	Update product in bundle deal		X
	End bundle deal		X
	Delete bundle deal		X
	Delete product in bundle deal		X
Discount	Get discount	X
	Get discount list	X
	Add discount		X
	Add discount item		X
	Delete discount		X
	Delete discount item		X
	Update discount		X
	Update discount item		X
	End discount		X
Firstmile	Get unbind order list	X
	Get first mile detail	X
	Get first mile tracking number list	X
	Get firstmile waybill file	X
	Get first mile channel list	X
	Generate first mile tracking number		X
	Bind first mile tracking number		X
	Unbind first file		X
Follow prize	Get follow prize detail	X
	Get follow prize list	X
	Add follow prize		X
	Delete follow prize		X
	End follow prize		X
	Update follow prize		X
Global product	Get global category	X
	Get attributes	X
	Get attribute tree	X
	Get a list of brand	X
	Get category dts limit	X
	Get global item upload control	X
	Get global item id list	X
	Get global item info	X
	Get global model list	X
	Get category support size chart	X
	Get publishable shop list for global item	X
	Get publish task result for global item	X
	Get published item list of global item	X
	Get global item id	X
	Recommend category by item name	X
	Get recommend attributes	X
	Add global item		X
	Update global item		X
	Delete global item		X
	Init tier variation		X
	Update tier variation		X
	Add global model		X
	Update global model		X
	Delete global model		X
	Update size chart for global item		X
	Create publish task for global item		X
	Update global price		X
	Update global stock		X
	Set auto sync field		X
Logistics	Get shipping parameter	X
	Get tracking number	X
	Get shipping document parameter	X
	Get shipping document result	X
	Get tracking info	X
	Get address list	X
	Get channel list	X
	Get shipping document data info	X
	Ship order		X
	Update shipping order		X
	Create shipping document		X
	Download shipping document		X
	Set address config		X
	Delete address		X
	Update channel		X
	Batch shiporder		X
Merchant	Get information of merchant	X
	Get shop list by merchant	X
	Get merchant warehouse location list	X
Order	Get order list	X
	Get shipment list	X
	Get order detail	X
	Get the pending invoice order list	X
	Get buyer invoice info	X
	Split an order		X
	Undo split		X
	Cancel an order		X
	Handle buyer's cancellation		X
	Set note for an order		X
	Add invoice data		X
	Upload the invoice document		X
Payment	Fetch the accounting list of the order	X
	Get payout detail	X
	Get shop installment status	X
	Get item installment status	X
	Obtain payment method	X
	Get the transaction records of wallet.	X
	Set shop installment status		X
	Set item installment status		X
Product	Get category	X
	Get attributes	X
	Get a list of items	X
	Get attribute tree	X
	Get brand list	X
	Get day to shipping limit	X
	Get item upload control	X
	Get item base info	X
	Get item extra info	X
	Get model list	X
	Support size chart	X
	Get boosted item list	X
	Get item promotion info	X
	Search item	X
	Get comment	X
	Get recommend attributes	X
	Get product info	X
	Get recommended weight	X
	Get new size chat list	X
	Get new size chart detail	X
	Add a new item		X
	Update item.		X
	Delete a product item		X
	Init tier variation		X
	Update tier variation		X
	Add model		X
	Update model		X
	Delete item model		X
	Updates size chart		X
	Unlist item		X
	Update price		X
	Update stock		X
	Boost item		X
	Update sip item price		X
	Reply comment		X
	Register a brand		X
Public	Get shops by partner	X
Public	Get merchants by partner	X
Push	Get app push config	X
Push	Set app push config		X
Returns	Get return detail	X
	Get return list	X
	Get available solutions	X
	Query proof	X
	Confirm refund		X
	Dispute return		X
	Offer		X
	Accept offer		X
Shop	Get information of shop	X
	Get profile	X
	Get warehouse detail	X
	Update profile		X
Shopcategory	Get list of shop categories	X
	Get items list	X
	Add a new shop collecion		X
	Delete a existing shop collecion		X
	Update a existing collecion		X
	Add items list to certain shop category		X
	Delete items from shop category		X
Toppicks	Get one toppicks	X
	Add one collection		X
	Update a collection info		X
	Delete a collection		X
Voucher	Get voucher detail	X
	Get voucher list	X
	Add voucher		X
	Delete voucher		X
	End voucher		X
	Update voucher		X