Class AmsManager

Add all eligible products into the Open Campaign. We will only return the general error that caused the whole task failure, without returning the specific error for each product in the v2.ams.get_open_campaign_batch_task_result API. If you want to get the result for each products, you can use v2.ams.batch_add_products_to_open_campaign by pagination manually, or check the product status by using the GET API after the task progress turn to 100%.

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. We will only return the general error that caused the whole task failure, without returning the specific error for each product in the v2.ams.get_open_campaign_batch_task_result API. If you want to get the result for each products, you can use v2.ams.batch_edit_products_open_campaign_setting by pagination manually, or check the product status by using the GET API after the task progress turn to 100%.

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. Due to data volume limitations, the maximum queryable time span is three months, etc.Maximum data can be viewed is 500 pages, please export data for more details.

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. We will only return the general error that caused the whole task failure, without returning the specific error for each product in the v2.ams.get_open_campaign_batch_task_result API. If you want to get the result for each products, you can use v2.ams. batch_remove_products_open_campaign_setting by pagination manually, or check the product status by using the GET API after the task progress turn to 100%.

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