Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Batch add products to the Open Campaign for a given list of product IDs
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Batch update open campaign settings for a given list of product IDs
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Fetch suggested rates for a given list of product IDs
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Batch update products from Open Campaign for a given list of product IDs
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Create a new campaign with custom product & affiliate selections, and basic info filling.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Modify the selected affiliate list in an existing target campaign
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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%.
Optionalparams: EditAllProductsOpenCampaignSettingRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Modify the selected product list in an existing target campaign
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve affiliate performance of the shop.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Check if auto-add new product is currently enabled
Optionalparams: GetAutoAddNewProductToggleStatusRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve key metrics for Open and Targeted campaigns
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve content performance of the shop
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Returns affiliates that are saved to managed affiliate list
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve all products currently in the Open Campaign, including campaign status, commission rate, and promotion period
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Get open campaign batch task result
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve eligible products not yet added to the Open Campaign
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve all products in the Open Campaign along with performance data
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve products with suggestions to improve performance
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve the latest date of AMS dashboard data metrics update.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve product performance of the shop.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Returns top 200 recommended affiliates that can be added to a campaign
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve overall key metrics for all channels or specific channels.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve suggested rates for all eligible products
Optionalparams: GetShopSuggestedRateRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Returns a list of products that can be added to a targeted campaign
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve all current targeted campaigns created by the seller
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve a list of Targeted Campaigns and their performance data
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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)
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve the seller's AMS validation bill
Optionalparams: GetValidationListRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve detailed information for a specific validation bill
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Retrieve affiliate information by affiliate id.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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%.
Optionalparams: RemoveAllProductsOpenCampaignSettingRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Change target campaign status to "terminated" to stop all affiliate promotion activity
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Change auto-add toggle and default commission rate setting
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Edit campaign name, promotion period, message, and budget (if the shop is whitelisted) of target campaign
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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%.