Significant OpenAPI Updates for AMS (Affiliate Marketing Solution) Management

Dear Developer,

To further enhance sellers’ operational efficiency and system integration capabilities in Affiliate Marketing Solutions (AMS), Shopee is officially launching the AMS Open API.

The AMS Open API provides developers with comprehensive automation capabilities for affiliate marketing, helping ISVs serve sellers more efficiently. It enables sellers to systematically manage promotional campaigns, track performance, and continuously optimize conversion results.

1. AMS Open API Overview

AMS is an integrated affiliate marketing and creator collaboration platform that helps sellers leverage Shopee’s content and creator ecosystem to increase product exposure and sales conversion.

With the AMS Open API, developers can integrate AMS functionalities into their own systems to:

1. Create and manage campaigns – Automate the creation and management of affiliate marketing campaigns, supporting both Open Campaigns and Targeted Campaigns.

2. Analyze and optimize performance – Access multi-dimensional performance, content, and conversion data for real-time monitoring and evaluation.

3. Improve operational efficiency – Automate campaign management, report retrieval, and billing reconciliation through API calls.

2. Key API Modules

The AMS Open API covers four major functional modules:

2.1 Open Campaign Management

Create and manage open promotional campaigns, supporting bulk product operations, commission settings, and campaign duration configuration.

• v2.ams.get_open_campaign_not_added_product – Retrieve products not yet added to Open Campaign
• v2.ams.batch_add_products_to_open_campaign – Add products to Open Campaign in batch
• v2.ams.batch_edit_products_open_campaign_setting – Edit product commission rate and campaign period in batch
• v2.ams.batch_remove_products_open_campaign_setting – Remove products in batch
• v2.ams.get_optimization_suggestion_product – Get product optimization suggestions
• Other APIs for auto-adding and batch task queries

2.2 Targeted Campaign Management

Invite specific creators for targeted promotion, with flexible product and commission strategies.

• v2.ams.create_new_targeted_campaign – Create a Targeted Campaign
• v2.ams.update_basic_info_of_targeted_campaign – Edit basic info of a Targeted Campaign
• v2.ams.edit_product_list_of_targeted_campaign – Edit campaign products
• v2.ams.edit_affiliate_list_of_targeted_campaign – Edit collaborating affiliates
• v2.ams.terminate_targeted_campaign – Terminate a Targeted Campaign
• Other APIs for retrieving campaign and affiliate information

2.3 Performance Dashboard

Access performance data at the shop, product, creator, and content levels for monitoring and optimization.

• v2.ams.get_shop_performance – Retrieve key shop metrics
• v2.ams.get_product_performance – Retrieve product performance data
• v2.ams.get_affiliate_performance – Retrieve affiliate performance data
• v2.ams.get_content_performance – Retrieve content performance data
• v2.ams.get_campaign_key_metrics_performance – Retrieve key campaign metrics
• Other APIs for data update timestamps and single campaign performance

2.4 Conversion & Validation Report

Retrieve order conversion details and commission settlement data for automated reconciliation.

• v2.ams.get_conversion_report – Retrieve conversion order details
• v2.ams.get_validation_list – Retrieve list of settlement reports
• v2.ams.get_validation_report – Retrieve detailed settlement report

For complete API documentation, please refer to the Shopee AMS API Integration Guide.

3. Usage Guidelines

• Application type requirement: Ensure your application type is “Affiliate Marketing Solution Management”, otherwise AMS APIs cannot be called.
• Seller agreement requirement: Confirm that sellers have signed the AMS T&C in Seller Center before API usage, or AMS functionalities will not work properly.

For any technical issues during integration, please contact us via the Open Platform Ticket System.

Thank you for your continued trust and collaboration. Shopee looks forward to working with you to drive the intelligent and automated evolution of the affiliate marketing ecosystem.

尊敬的开发者，

为进一步提升卖家在联盟营销 (Affiliate Marketing Solution，简称 AMS) 方面的运营效率与系统集成能力，Shopee 现正式推出 AMS Open API。

本次 AMS Open API 为开发者提供了完善的联盟营销自动化能力，帮助 ISV 更高效地服务卖家，助力卖家通过系统化方式管理推广活动、追踪绩效表现，并持续优化转化效果。

1. AMS Open API 简介

AMS 是一体化的联盟营销与创作者合作平台，帮助卖家借助 Shopee 的内容与创作者生态，提升商品曝光度与销售转化。

通过 AMS Open API，开发者可将 AMS 功能集成至自身系统，实现：

1. 创建与管理活动：自动化创建和管理联盟推广活动，支持 Open Campaign 与 Targeted Campaign 两种模式；

2. 分析与优化效果：提供多维度的绩效、内容及转化数据，实现实时监控与效果评估；

3. 提升运营效率：通过接口实现活动管理、报表拉取及账单核对等自动化操作。

2. 主要接口功能概览

2.1 Open Campaign 管理

创建并管理开放推广活动，支持批量商品操作、佣金设置及推广周期配置。

• v2.ams.get_open_campaign_not_added_product – 获取尚未加入 Open Campaign 的商品
• v2.ams.batch_add_products_to_open_campaign – 批量添加商品至 Open Campaign
• v2.ams.batch_edit_products_open_campaign_setting – 批量编辑商品佣金与推广周期
• v2.ams.batch_remove_products_open_campaign_setting – 批量移除商品
• v2.ams.get_optimization_suggestion_product – 获取商品优化建议
• 以及其他自动添加与批量任务查询等相关接口

2.2 Targeted Campaign 管理

向邀请特定创作者参与推广，灵活配置商品与佣金策略。

• v2.ams.create_new_targeted_campaign – 创建 Targeted Campaign
• v2.ams.update_basic_info_of_targeted_campaign - 编辑 Targeted Campaign 基础信息
• v2.ams.edit_product_list_of_targeted_campaign – 编辑活动商品
• v2.ams.edit_affiliate_list_of_targeted_campaign – 编辑合作达人
• v2.ams.terminate_targeted_campaign – 终止 Targeted Campaign
• 以及其他获取活动信息与达人信息等相关接口

2.3 Performance Dashboard

获取店铺、商品、创作者及内容层级的绩效数据，用于效果监控与优化。

• v2.ams.get_shop_performance – 获取店铺核心数据
• v2.ams.get_product_performance – 获取商品表现数据
• v2.ams.get_affiliate_performance – 获取达人表现数据
• v2.ams.get_content_performance – 获取内容表现数据
• v2.ams.get_campaign_key_metrics_performance – 获取活动关键指标数据
• 以及其他获取数据更新时间与单个活动表现数据等相关接口

2.4 Conversion & Validation Report

获取订单转化明细与佣金结算数据，实现自动化结算与对账。

• v2.ams.get_conversion_report – 获取转化订单明细
• v2.ams.get_validation_list – 获取对账单列表
• v2.ams.get_validation_report – 获取对账单明细

完整接口说明可参考：Shopee AMS API Integration Guide。

3. 使用指南

• 应用类型要求：请确保您的应用类型为 “Affiliate Marketing Solution Management”，否则无法调用 AMS 相关接口。
• 卖家签署要求：调用前请确认卖家已在 Seller Center 完成 AMS 服务协议 签署，否则无法正常使用 AMS 功能。

如在接入过程中遇到任何技术问题，请通过 Open Platform 工单系统 联系我们。

感谢您一直以来的信任与合作，Shopee 期待与您携手，共同推动联盟营销生态的智能化与自动化升级。