Shopee MCP server for your AI

Add a new item.

Get the attribute tree for categories.

Use this api to get comment by shop_id, item_id, or comment_id, get up to 1000 comments.

Use this api to get basic info of item by item_id list.

Use this api to get extra info of item by item_id list.

Use this call to get a list of items.

Get model list of an item.

Lists the shop's listings with their names, prices, stock and status, in one call.

Everything needed before shopee_add_item: the category for a product name, that category's attributes (mandatory ones marked), its first brands, the shop's enabled shipping channels and the shop's limits.

Recommend category by item name.

Use this api to reply comments from buyers in batch.

Use this call to search item.

Unlist item.

Update item.

Update price.

Use this API to update one item_id for each call, but still can support updating multiple model_ids stock of the same item_id (If you need batch modification, please call multiple times)This API will update only "seller_stock".Whenever there is a promotion ongoing or upcoming, the total stock must be larger than or equal to real-time “reserved_stock” promotion stock.

Use this api to create shipping document task for each order or package and this API is only available after retrieving the tracking number.

Use this api to download shipping_document.

Use this api to get all supported logistic channels.

One order and where its shipping stands: details, what shopee_ship_order needs (pickup or drop-off choices), the tracking number and what the seller receives.

Use this api to retrieve the status of the shipping document task.

Use this api to check if the package support pickup, dropoff, or non-integrated method.

After arranging shipment (v2.logistics.ship_order) for the integrated channel, use this api to get the tracking_number, which is a required parameter for creating shipping labels.

Use this api to initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels.

Use this API to return the seller's Real-time total balance of their ads credit including the paid credits and free credits.

Use this api to cancel an order.

Use this api to get order detail.

Use this api to search orders.

Use this api to handle buyer's cancellation application.

Lists orders with their items, buyer, totals and shipping, for a range of up to 90 days.

Adds up orders over a range of up to 90 days: order and unit counts, what buyers paid per currency, orders per status, and the top items.

Use this API to fetch the accounting detail of order.

Use this API to get the transaction records of wallet.

Use this api to get detail information of a return by return sn.

Use this api to get detail information of many return by shop id.

Use this api to get shop discount activity list.

Use this call to get information of shop.

Start here for "how is my shop doing".

The data metrics of shop performance.

Get Voucher List.

Use this API to upload multiple image files (less than 9 images).

Create the kit item by selecting multiple items and setting main component and quantity per kit.

Add model.

Create asynchronous task to batch add item.

Create asynchronous task to batch publish outlet item.

Create asynchronous task to batch update outlet item's price.

Create asynchronous task to batch update outlet stock.

Boost item.

Use this call to delete a product item.

Delete item model.

This API generates a single consolidated image by combining the cover images of all selected items.

Get the list of A Items under SIP Affiliate Shop corresponding to P Items under SIP Primary Shop.

Use this Open API to get all vehicle list.

Query batch task result.

Get boosted item list.

Get the brand data of a leaf category.

Get category tree data.

get direct item by main item.

get recommend price for direct shop.

Get the content quality details (including content quality level, content issues, and system suggestions) for specific product list.

Get item upload control.

Query the list of products and their content quality details by content quality level or content issues.

Get item promotion info.

get item violation info.

Get the kit basic information and kit components.

Get the limit of Kit item.

get main item by direct item.

Get the mapping information between a Mart item and its corresponding outlet item by outlet item ID.

Get the mapping information between a Mart item and its corresponding outlet item by item ID.

Get product certification rule.

Get recommend attributes.

Get new size chart detail.

Get new size chart list.

Get the details of an SSP or CSSP.

Get the SSP enrollment recommendations of the authorized shop, separating items that can be enrolled automatically from items that may be enrolled after further action.

Get the standardized tier variation defined by Shopee, which is currently a three-layer tree structure.

Use this Open API to get vehicle list by brand, model, year, and version.

Get recommended weight.

This API allows you to update the tier structure of a product.

Link one or more models of an item to their country-specific SSPs.

This API supports publishing an existing item from the mart shop to an outlet shop.

Use this call to register a brand.

this api is for searching attribute value list for attribute with support_search_value flag.

Search SSPs by title or by image.

Use this API to retrieve Unpackaged SKU ID information for items that toggle on logistics channel 30029.

Remove the SSP links of one or more models of an item.

Update the kit basic information and kit components, only support adding kit variations and updating existing kit variation’s image, price, and model_sku, don’t support deleting existing kit variations and updating the items, main component and quantity per kit of existing kit variations.

Update seller sku/ pre order/ model status for model.

Update sip item price.

This api can only be used without changing the tier structure, you can add options, delete options, and update the option image by this api.

Use this api to batch initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels.

For CB orders that fulfilled by 3PF, support 3PF Warehouse Vendors to update the tpf_tracking_status when 3PF warehouse receive the order and complete the outbound of the package.

Only available for Brazil sellers.

Use this api to create shipping document task for each booking and this API is only available after retrieving the tracking number.

This API creates a shipping document job for selected documents.

Use this api to delete address.

This API is used to delete a specific special operating hour for a seller.

Use this api to download shipping_document.

This API allows users to download the shipping document associated with a specific job ID.

This API allows users to download the shipping document associated with a specific job ID.

Use the API to download the TO label that should be attached to the carton before drop-off at the warehouse.

Use the API to download the TO label that should be attached to the carton before drop-off at the warehouse.

For integrated logistics channel, use this call to get pickup address for pickup mode order.

Use this api to fetch the logistics information of a booking these info can be used for airwaybill printing.

Use this api to get the selectable shipping_document_type and suggested shipping_document_type.

Use this api to retrieve the status of the shipping document task.

Use this api to get the parameter "info_needed" from the response to check if the booking has pickup or dropoff.

Use this api to get the logistics tracking information of a booking.

After arranging shipment (v2.logistics.ship_booking) for the integrated channel, use this api to get the tracking_number, which is a required parameter for creating shipping labels.

[Only for ID mart seller] The API allows sellers to retrieve their current packaging fee settings.

Use this api to check if package support pickup, dropoff, non-integrated.

After arranging shipment (v2.logistics.mass_ship_order) for the integrated channel, use this api to get the tracking_number, which is a required parameter for creating shipping labels.

This API is designed to retrieve all restrictions related to inputting operating hours for the v2.logistics.update_operating_hours function.

This API is utilized to retrieve the existing operating hours of sellers including Pickup Operating Hours, Special Hours, Instant Operating Hours, and Shop Collection Operating Hours.

This API returns the pause status of logistics channels under the shop.

Use this api to fetch the logistics information of an order, these info can be used for self-design AWB printing.

This API retrieves the status of a shipping document job using the job ID provided.

Use this api to get the selectable shipping_document_type and suggested shipping_document_type.

Use this api to get the logistics tracking information of an order.

Use this api to initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels.

Use this API to set address config of your shop.

[Only for ID mart seller] This API allows sellers to set up their packaging fee info.

Use this API to set the pause status of logistics channels under the shop.

Use this api to initiate logistics including arrange pickup, dropoff.

Use this API to update the address of a shop.

Use this api to update shop level logistics channel's configuration.

This API is designed to allow sellers to update their operating hours.

Use this api to update the order status for buyer to collect the orders directly from your pharmacy.

For pickup method only, use this api to update pickup address and pickup time for packages meet: 1) package's fulfillment status is LOGISTICS_PICKUP_RETRY; or 2) package's fulfillment status is 'LOGISTICS_REQUEST_CREATED' and meets the Instant Order Reschedule Pickup conditions.

Only available for Brazil sellers.

Only available for Brazil sellers.

Add all eligible products into the Open Campaign.

Batch add products to the Open Campaign for a given list of product IDs.

Batch update open campaign settings for a given list of product IDs.

Fetch suggested rates for a given list of product IDs.

Batch update products from Open Campaign for a given list of product IDs.

Create a new campaign with custom product & affiliate selections, and basic info filling.

Modify the selected affiliate list in an existing target campaign.

Update for all products in the Open Campaign.

Modify the selected product list in an existing target campaign.

Retrieve affiliate performance of the shop.

Check if auto-add new product is currently enabled.

Retrieve key metrics for Open and Targeted campaigns.

Retrieve content performance of the shop.

Retrieve the shop's conversion report with details about each order, item, affiliate, campaign.You can filter results using one or multiple time ranges, and the final result will be the intersection of these ranges.

Returns affiliates that are saved to managed affiliate list.

Retrieve all products currently in the Open Campaign, including campaign status, commission rate, and promotion period.

Get open campaign batch task result.

Retrieve eligible products not yet added to the Open Campaign.

Retrieve all products in the Open Campaign along with performance data.

Retrieve products with suggestions to improve performance.

Retrieve the latest date of AMS dashboard data metrics update.

Retrieve product performance of the shop.

Returns top 200 recommended affiliates that can be added to a campaign.

Retrieve overall key metrics for all channels or specific channels.

Retrieve suggested rates for all eligible products.

Returns a list of products that can be added to a targeted campaign.

Retrieve all current targeted campaigns created by the seller.

Retrieve a list of Targeted Campaigns and their performance data.

For each campaign, return: campaign basic info (name, status, promotion period, message), selected product list (with product name & ID), selected affiliate list (with affiliate names).

Retrieve the seller's AMS validation bill.

Retrieve detailed information for a specific validation bill.

Retrieve affiliate information by affiliate id.

Remove the entire product list of Open Campaign.

Change target campaign status to "terminated" to stop all affiliate promotion activity.

Change auto-add toggle and default commission rate setting.

Edit campaign name, promotion period, message, and budget (if the shop is whitelisted) of target campaign.

Add global item.

Add global model.

Get category support size chart.

Create publish task for global item.

Delete global item.

Delete global model.

Get get_global_item_id by item_id.

Get global item info.Only for China mainland sellers and Korean sellers.

Get global item upload control.

Get global item id list.

Get global model list.

Get the mtsku attribute trees for categories.

Use this call to get a list of brand.

Get global category.

Retrieves the adjustment rate that converts CB stock price into local-warehouse price for a specific shop.

Get publish task result for global item.

Get publishable shop list for global item.

Get published item list of global item.

Get recommend attributes.

Get publishable shop list for global item in pages.

Get new size chart detail.

Get size chart list.

Get the standardized tier variation defined by Shopee, which is currently a three-layer tree structure.

Only for China mainland sellers and Korean sellers.

Recommend category by item name.

this api is for searching attribute value list for attribute with support_search_value flag.

Set auto sync field.

Update global item.

Update global model.

A multiplier that automatically converts your CB stock price into the local-warehouse price.

Update global price.

Update size chart for global item.

Update global stock.

Update global product tier variation.

Add items to item bag.

Add product set to item bag.

Ban the user from posting comments.

Check the seller's eligibility in creating a GMS campaign.

Create a GMS campaign.

Use this API to create Auto Product Ads.

Create a new live stream, include basic information, like cover, title, description, type (test live or normal live).

Use this API to create Manual Selection Product Ads.

Delete items from item bag.

Unshow showing item.

Add/remove items to/from the GMS Campaign.

Edit a GMS campaign.

Use this API to edit Manual Selection Product Ad Keywords.

Use this API to edit Auto Product Ads.

Use this API to edit Manual Selection Product Ads.

End Live.

Call this API to get budget suggestion for product ads creation.

Get shop rate for Ads Facil Program.

Get GMS Campaign performance.

Get GMS Item performance 1.

Use this API to get Product level ads multiple-days daily performance.

Use this API to get Product level ads single-day hourly performance.

Call this API to fetch all the product campaign ids displayed on advertiser platform under a specific Shop.

Call this API to fetch all the campaign setting info under this Shop.

Get Product Recommended ROI Target.

Use this API to get the list of recommended SKU (Shop level) with the corresponding tag, i.e top search/best selling/best ROI tag.

Use this API to get the list of Recommended keywords by item and optionally a search keyword.

Use this API to get Shop level info - i.e. seller's toggle status is on/off.

Use this API to get Shop level CPC ads multiple-days daily performance.

Use this API to get Shop level CPC ads single-date hourly performance.

Get the number of items in the shopping bag, including the current number of items in the shopping bag, the upper limit of the number, etc.

Get the detail information of item in item bag, including item id, item serial number, etc.(For TW, ID, TH, PH, MY, SG, VN).

Get the item list of the product set, including item name, id, etc.

Get the product set of the live stream, including the product set name, id, and item number.

Get live stream room comments in the last 10 seconds, including user id, user name, comment id, comment content, and comment time.

Get the item list of My Likes tab.(For TW, ID, TH, PH, MY, SG, VN).

Get the item list of the Recently tab.

Get basic information about the live streaming room, including cover, title, description, type (test live or normal live), create time, update time, stream url, etc.

Get real-time indicator data of live stream products, including product clicks, add-to-cart, etc.

Get real-time indicator data of the live stream room, including the number of likes, comments, shares, views, etc.(For TW, ID, TH, PH, MY, SG, VN).

Get the showing item.

List GMS items that have been removed from the Campaign by seller.

Post comment in the live stream as streamer.

Start Live.

Unban an user from posting comments.

Update the order of items in item bag.

Update live stream information, including cover, title, description, and type (test live or normal live).

Set the showing item.

Upload an image as the live stream cover.(For TW, ID, TH, PH, MY, SG, VN).

This API allows you to download FBS invoices.

This endpoint only for PH and BR local seller.

This API creates a task to download a specific tax document (e.g., sales invoice, remessa invoice) for the seller's account, available only after the document is issued by the system as part of the Fulfilled by Shopee (FBS) process.

Use this api to get booking detail.

Use this api to search bookings.

API to obtain buyer submitted invoice info for VN, TH and PH local sellers only.

Returns the estimated refund value for a partial order cancellation given the specified items to cancel.

This API allows you to consult the status of a previously requested batch download for FBS tax documents.

Use this api to get package detail.

This endpoint only for PH and BR local sellers only.

Use this api to get order list which order_status is READY_TO_SHIP or RETRY_SHIP to start process the whole shipping progress.

For multi-warehouse shops, return all warehouses with packages that have not been SHIPPED including product_location_id and address_id.

Use this API to approve or reject a prescription.

Use this API to search the list of packages that have not been SHIPPED to proceed arranging shipment, and it supports various filters and sort fields.

Use this api to set note for an order.

Use this api to split an order into multiple packages.

Use this ai to undo split of order.

This endpoint is for PH and BR local seller.

Use this api to bind first mile tracking number for courier delivery method.

Use this api to bind first mile tracking number.

Use this api to cancel first mile tracking number for courier delivery method.

Use this api to generate first mile tracking number for courier delivery method.

Use this api to generate first mile tracking number.

Trigger income report generation.

Trigger income statement generation.

This API is applicable for Cross Border (CB) sellers only to get the detailed payout transaction data, both released and to-be released transaction can be found in here.

Use this API to fetch the details of order income by batch.

Use this API to fetch the accounting list of order.

Use this api to get first mile channel list.

Use this api to get courier information for courier delivery method.

Use this api to get first mile detail for courier delivery method.

Use this api to get tracking number for courier delivery method.

Use this api to get first mile waybill file for courier delivery method.

Use this api to get first mile detail.

Use this api to get first mile tracking number list.

Use this api to get transit warehouse list which is used for first mile tracking number generation for courier delivery method.

Use this api to get unbind order list.

Use this api to get first mile waybill file.

Use this api to get first mile waybill file link.

Retrieves detailed order-level income information across various income statuses for a specified time period.

Retrieves a consolidated snapshot of the seller’s income amounts categorized by income status for a specified shop.

To query income report status and provide file link if the income report is ready to be downloaded.

To query income statement status and provide file link if the income statement is ready to be downloaded.

Get item installment tenures.Only for TH、TW.

Obtain payment method (no authentication required).

This API is applicable for Cross Border (CB) sellers only to get the shop's payout data, such as the payout amount, currency, FX rate, the payout's associated order income and adjustment records etc.

This is a new API which applicable for Cross Border (CB) sellers only to get the shop's payout data, will be used for the original API v2.get_payout_details replacement, we provide data such as the payout amount, currency, FX rate, the payout's associated order income and adjustment records etc.

Get the installment state of shop.

Set item installment.Only for TH、TW.

Sets the staging capability of shop level.

Use this api to unbind first mile.

Use this api to unbind orders from first mile tracking number or binding ID.

Shopee v2.returns.accept_offer.

Sellers can only cancel compensation disputes, not normal disputes.

Confirm refund.

Convert a specific format and pictures within 10M into url.

Use this API to delete video.

Dispute return.

You need to call v2.media.init_video_upload, v2.media.upload_video_part, and v2.media.complete_video_upload to upload the video, and call the v2.media.get_video_upload_result to get the video_upload_id of uploaded video first, then call this API to set video post information.

Get the available solutions offered to buyers.

To get the dispute return reason.

Get reverse and post-return logistics information of return request.

Use this API to get the list of shipping carriers and request parameters needed before calling v2.returns.upload_shipping_proof.

You need to call v2.media.init_video_upload, v2.media.upload_video_part, and v2.media.complete_video_upload to upload the video, and call the v2.media.get_video_upload_result to get the video_upload_id of uploaded video.

Get the detail information of video.

Get detailed audience distribution data for individual post Shopee Video.

Get detailed metric trend data for individual post Shopee Video.

Get detailed performance data for individual post Shopee Video.

Get performance data for products linked with individual post Shopee Video.

Get the list of video in draft status or video already post to Shopee Video.

Query video data indicator trends.

Get overall performance data for all post Shopee Video.

Get specific performance data for individual post Shopee Video.

Get specific performance data for products linked with Shopee Video.

Get user demographics data to better understand the types of viewers that watch your Shopee Video.

Shopee v2.returns.offer.

You need to call v2.media.init_video_upload, v2.media.upload_video_part, and v2.media.complete_video_upload to upload the video, then call the v2.video.edit_video_info API to set video post information, finally call this API to post the video to Shopee Video.

Support sellers to query the evidence uploaded through the upload evidence API.

Support sellers to upload evidence, including text and pictures and videos converted into URLs.

Use this API to upload shipping proof.

Add Add-on Deal.

Add Add-on Deal Main Item.

Add Add-on Deal Sub Item.

Delete Add-on Deal.

Delete Add-on Deal Main Item.

Delete Add-on Deal Sub Item.

End Add-on Deal.

Get Add-on Deal.

Get Add-on Deal List.

Get Add-on Deal Main Item.

Get Add-on Deal Sub Item.

Update Add-on Deal.

Update Add-on Deal Main Item.

Update Add-on Deal Sub Item.

Use this api to add shop discount activity.

Use this api to add shop discount item.

Use this api to delete one discount activity.

Use this api to delete items of the discount activity.

Delete SIP Overseas Discounts for SIP affiliate region.

Use this api to end shop discount activity.

Use this api to get one shop discount activity detail.

Get SIP Overseas Discounts.

Set SIP Overseas Discount for SIP affiliate region.

Use this api to update one discount information.

Use this api to update items of the discount promotion.

add shop flash sale item.

creat shop flash sale.

delete shop flash sale.

delete shop flash sale items.

Queries affiliate performance data for the specified principal within the selected time range.

Queries video clip performance data for the specified videos within the selected time range.

Queries affiliate performance data for the specified content items within the selected time range.

Queries livestream performance data for the specified principal within the selected time range.

Queries the business performance data aggregated at principal level for the specified regions within the selected time range.

Queries livestream session performance data for the specified sessions within the selected time range.

Queries affiliate performance data for the specified shops within the selected time range.

Queries livestream performance data for the specified shops within the selected time range.

Queries the business performance data of stores under the specified entity within the selected time range.

Queries video performance data for the specified shops within the selected time range.

Queries video performance data for the specified principal within the selected time range.

get shop flash sale detail.

get shop flash sale item criteria.

get shop flash sale items and item detail.

get shop flash sale list.

get time slot id.

edit shop flash sale(enable, disable).

edit shop flash sale item, you can only edit the models in disbaled or enabled status.

create bundle deal.

add product to bundle deal.

delete bundle deal.

delete product in bundle deal.

end bundle deal.

Get the authorised reseller brand list for the shop.

[For BR Shop Only] Use this API to get shop KYC registration and qualification information.

get bundle deal detail.

get bundle deal item.

get bundle deal list.

This API support to get information of shop.

Use this API to check whether a shop has enabled holiday mode and its ongoing and upcoming holiday mode period.

get Seller Center notification, the permission is controlled by App type.

For given shop id and region, return warehouse info including warehouse id, address id and location id, return all warehouse with once call.

Use this API to set holiday periods in advance for automatic on/off of holiday mode and there are two holiday modes allowing sellers to choose whether to accept new orders during holiday.

update bundle deal.

update product in bundle deal.

This API support to let sellers to update the shop name, shop logo, and shop description.

Use this call to add a new shop collecion.

Use this call to add items list to certain shop_category.

Use this call to delete an existing shop collecion.

Use this api to delete items from shop category.

Use this call to get items list of certain shop_category.

Use this call to get list of shop categories.

Use this call to update an existing collecion.

OpenAPI add Follow Prize.

Add voucher.

Use this API to cancel an ongoing video upload task.

Cancel a video upload session.

Use this API to finalize a video upload task.

Complete the video upload and starts the transcoding process when all parts are uploaded successfully.

delete_follow_prize.

Delete voucher.

end follow prize.

End Voucher.

get_follow_prize_detail.

OpenAPI get_follow_prize_list.

Get the Late Orders to take action to avoid order cancellation and penalty points.

Get the Problematic Listings to improve the listings to avoid incurring penalty points.

Use this API to retrieve the current status and result of a video upload task.

Use this call to get information of merchant.

Use this api to get seller’s courier prepaid account.

Get merchant warehouse with page.

get merchant warehouse location list.

Get the Affected Orders / Relevant Listings / Relevant Violations details of metrics.

Get the penalty point records generated in the current quarter.

Get the punishment records generated in the current quarter.

get bound warehouse by shop id.

Get Seller Center Current Inventory Page Data.

Seller Center Expiry Report page data.

This API is designed for sellers using Fulfillment Mapping and their ERP systems.

Get Seller Center Stock Aging page data.

Get Seller Center，Stock Movement page data.

Use this call to get shop_list bound to merchant_id.

Query the upload status and result of video upload.

Get Voucher Detail.

Get eligible shop list by warehouse id.

Use this API to initialize a new video upload task and obtain an unique upload session ID.

Initiate video upload session.

update_follow_prize.

Update voucher.

Use this API to upload images and support different business scenarios through business and scene parameters.

Use this API to upload a video file in parts.

Upload video file by part using the upload_id in initiate_video_upload.

Get Buybox model performance by model IDs for the authorized shop.

Get Buybox model information by model IDs for the authorized shop.

Get the paginated Buybox model list for the authorized shop.

Get Buybox shop performance for the authorized shop.

Update Buybox model enrollment status for the authorized shop.

add one collection.

Confirm consumed lost push message.

delete a collection.

you can get your app current push config setting through this api.

Get the lost push messages that were lost within 3 days of the current time and not confirmed to have been consumed.

get one TopPicks.

This API checks whether an FBS shop is blocked due to invoice-related issues.

This API checks whether a given shop_id is eligible to enroll in the Brazil Fulfilled-by-Shopee (FBS) service.

This API handles failed invoice issuance for FBS-related processes, covering Inbound Requests, RTS Requests, Sales Orders, and Move Transfer Orders.

This API checks whether an FBS product is blocked due to invoice-related issues.

you can turn on or turn off your app push config setting through this open api.

update a collection info.

Use this API to get basic info of merchants which have authorized to the partner.

You can get shopee ip address ranges through this open api.

get basic info of shops which have authorized to the partner.

Receive installation order.

Validate installation order OTP code.

Provide all metrics currently available on the Business Insights Buybox dashboard, including metrics not explicitly requested by Local (for example, CTR), covering both: Shop-level performance Product-level performance.