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 |
|---|---|---|---|
|
Account health |
Get late orders |
X |
|
|
Get listings with issues |
X |
||
|
Get metric source detail |
X |
||
|
Get penalty point history |
X |
||
|
Get punishment history |
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 |
||
|
Ads |
Check create GMS product campaign eligibility |
X |
|
|
Create GMS product campaign |
X |
||
|
Create manual product ads |
X |
||
|
Edit GMS item product campaign |
X |
||
|
Edit GMS product campaign |
X |
||
|
Edit manual product ad keywords |
X |
||
|
Edit manual product ads |
X |
||
|
Get ads fácil shop rate |
X |
||
|
Get all CPC ads daily performance |
X |
||
|
Get all CPC ads hourly performance |
X |
||
|
Get create product ad budget suggestion |
X |
||
|
Get product campaign daily performance |
X |
||
|
Get product campaign hourly performance |
X |
||
|
Get product level campaign ID list |
X |
||
|
Get product level campaign setting info |
X |
||
|
Get product recommended ROI target |
X |
||
|
Get recommended item list |
X |
||
|
Get recommended keyword list |
X |
||
|
Get shop toggle info |
X |
||
|
Get total balance |
X |
||
|
List GMS user deleted item |
X |
||
|
Affiliate AMS |
Add all products to open campaign |
X |
|
|
Batch add products to open campaign |
X |
||
|
Batch edit products open campaign setting |
X |
||
|
Batch get products suggested rate |
X |
||
|
Batch remove products open campaign setting |
X |
||
|
Create new targeted campaign |
X |
||
|
Edit affiliate list of targeted campaign |
X |
||
|
Edit all products open campaign setting |
X |
||
|
Edit product list of targeted campaign |
X |
||
|
Get affiliate performance |
X |
||
|
Get auto add new product toggle status |
X |
||
|
Get campaign key metrics performance |
X |
||
|
Get content performance |
X |
||
|
Get conversion report |
X |
||
|
Get managed affiliate list |
X |
||
|
Get open campaign added product |
X |
||
|
Get open campaign batch task result |
X |
||
|
Get open campaign not added product |
X |
||
|
Get open campaign performance |
X |
||
|
Get optimization suggestion product |
X |
||
|
Get performance data update time |
X |
||
|
Get product performance |
X |
||
|
Get recommended affiliate list |
X |
||
|
Get shop performance |
X |
||
|
Get shop suggested rate |
X |
||
|
Get targeted campaign addable product list |
X |
||
|
Get targeted campaign list |
X |
||
|
Get targeted campaign performance |
X |
||
|
Get targeted campaign settings |
X |
||
|
Get validation list |
X |
||
|
Get validation report |
X |
||
|
Query affiliate list |
X |
||
|
Remove all products open campaign setting |
X |
||
|
Terminate targeted campaign |
X |
||
|
Update auto add new product setting |
X |
||
|
Update basic info of targeted campaign |
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 |
||
|
Delete sip discount |
X |
||
|
Get sip discounts |
X |
||
|
Set sip discount |
X |
||
|
First mile |
Get unbind order list |
X |
|
|
Get first mile detail |
X |
||
|
Get first mile tracking number list |
X |
||
|
Get first mile 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 |
||
|
Bind courier delivery first mile tracking number |
X |
||
|
Generate and bind first mile tracking number |
X |
||
|
Get courier delivery channel list |
X |
||
|
Get courier delivery detail |
X |
||
|
Get courier delivery waybill |
X |
||
|
Get transit warehouse list |
X |
||
|
Unbind first mile tracking number all |
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 |
||
|
Fulfillment FBS |
Query BR shop block status |
X |
|
|
Query BR shop enrollment status |
X |
||
|
Query BR shop invoice error |
X |
||
|
Query BR SKU block status |
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 |
||
|
Get local adjustment rate |
X |
||
|
Get shop publishable status |
X |
||
|
Get size chart detail |
X |
||
|
Get size chart list |
X |
||
|
Get variations |
X |
||
|
Update local adjustment rate |
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 |
||
|
Batch update tpf warehouse tracking status |
X |
||
|
Check polygon update status |
X |
||
|
Create booking shipping document |
X |
||
|
Create shipping document job |
X |
||
|
Delete special operating hour |
X |
||
|
Download booking shipping document |
X |
||
|
Download shipping document job |
X |
||
|
Download to label |
X |
||
|
Get booking shipping document data info |
X |
||
|
Get booking shipping document parameter |
X |
||
|
Get booking shipping document result |
X |
||
|
Get booking shipping parameter |
X |
||
|
Get booking tracking info |
X |
||
|
Get booking tracking number |
X |
||
|
Get mart packaging info |
X |
||
|
Get mass shipping parameter |
X |
||
|
Get mass tracking number |
X |
||
|
Get operating hour restrictions |
X |
||
|
Get operating hours |
X |
||
|
Get pause status |
X |
||
|
Get shipping document job status |
X |
||
|
Mass ship order |
X |
||
|
Set mart packaging info |
X |
||
|
Set pause status |
X |
||
|
Ship booking |
X |
||
|
Update address |
X |
||
|
Update operating hours |
X |
||
|
Update self collection order logistics |
X |
||
|
Update tracking status |
X |
||
|
Upload serviceable polygon |
X |
||
|
Media |
Cancel video upload |
X |
|
|
Complete video upload |
X |
||
|
Get video upload result |
X |
||
|
Init video upload |
X |
||
|
Upload image |
X |
||
|
Upload video part |
X |
||
|
Media space |
Cancel video upload |
X |
|
|
Complete video upload |
X |
||
|
Get video upload result |
X |
||
|
Init video upload |
X |
||
|
Upload image |
X |
||
|
Upload video part |
X |
||
|
Merchant |
Get information of merchant |
X |
|
|
Get shop list by merchant |
X |
||
|
Get merchant warehouse location list |
X |
||
|
Get merchant prepaid account 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 |
||
|
Download FBS invoices |
X |
||
|
Download invoice doc |
X |
||
|
Generate FBS invoices |
X |
||
|
Get booking detail |
X |
||
|
Get booking list |
X |
||
|
Get FBS invoices result |
X |
||
|
Get package detail |
X |
||
|
Get warehouse filter config |
X |
||
|
Handle prescription check |
X |
||
|
Search package list |
X |
||
|
Payment |
Fetch the accounting detail of order |
X |
|
|
Fetch the accounting list of 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 |
||
|
Generate income report |
X |
||
|
Generate income statement |
X |
||
|
Get escrow detail batch |
X |
||
|
Get income detail |
X |
||
|
Get income overview |
X |
||
|
Get income report |
X |
||
|
Get income statement |
X |
||
|
Get payout info |
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 |
||
|
Recommend category by item name |
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 |
||
|
Add kit item |
X |
||
|
Add SSP item |
X |
||
|
Generate kit image |
X |
||
|
Get aitem by pitem ID |
X |
||
|
Get all vehicle list |
X |
||
|
Get direct item list |
X |
||
|
Get direct shop recommended price |
X |
||
|
Get item content diagnosis result |
X |
||
|
Get item violation info |
X |
||
|
Get kit item info |
X |
||
|
Get kit item limit |
X |
||
|
Get main item list |
X |
||
|
Get mart item by outlet item ID |
X |
||
|
Get mart item mapping by ID |
X |
||
|
Get product certification rule |
X |
||
|
Get SSP info |
X |
||
|
Get SSP list |
X |
||
|
Get variations |
X |
||
|
Get vehicle list by compatibility detail |
X |
||
|
Link SSP |
X |
||
|
Publish item to outlet shop |
X |
||
|
Unlink SSP |
X |
||
|
Update kit item |
X |
||
|
Public |
Get shops by partner |
X |
|
|
Get merchants by partner |
X |
||
|
Get Shopee IP ranges |
X |
||
|
Get token by resend code |
X |
||
|
Push |
Get app push config |
X |
|
|
Set app push config |
X |
||
|
Confirm consumed lost push message |
X |
||
|
Get lost push message |
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 |
||
|
Cancel dispute |
X |
||
|
Convert image |
X |
||
|
Get return dispute reason |
X |
||
|
Get reverse tracking info |
X |
||
|
Get shipping carrier |
X |
||
|
Upload proof |
X |
||
|
Upload shipping proof |
X |
||
|
Seller SBS |
Get bound whs info |
X |
|
|
Get current inventory |
X |
||
|
Get expiry report |
X |
||
|
Get stock aging |
X |
||
|
Get stock movement |
X |
||
|
Shop |
Get information of shop |
X |
|
|
Get profile |
X |
||
|
Get warehouse detail |
X |
||
|
Update profile |
X |
||
|
Get authorized reseller brand |
X |
||
|
Get BR shop onboarding info |
X |
||
|
Get shop holiday mode |
X |
||
|
Get shop notification |
X |
||
|
Set shop holiday mode |
X |
||
|
Shop category |
Get list of shop categories |
X |
|
|
Get items list |
X |
||
|
Add a new shop collecion |
X |
||
|
Delete an existing shop collecion |
X |
||
|
Update an existing collecion |
X |
||
|
Add items list to certain shop category |
X |
||
|
Delete items from shop category |
X |
||
|
Shop flash sale |
Add shop flash sale items |
X |
|
|
Create shop flash sale |
X |
||
|
Delete shop flash sale |
X |
||
|
Delete shop flash sale items |
X |
||
|
Get item criteria |
X |
||
|
Get shop flash sale |
X |
||
|
Get shop flash sale items |
X |
||
|
Get shop flash sale list |
X |
||
|
Get time slot ID |
X |
||
|
Update shop flash sale |
X |
||
|
Update shop flash sale items |
X |
||
|
Top picks |
Get one top picks |
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 |