Add all products to open campaign
Use this API to add all shop products to the open campaign with specified commission rate and period.
Parameters for adding all products
Promise with task ID for checking batch task result
Batch add products to open campaign
Use this API to add specific products to the open campaign.
Parameters including item IDs, commission rate, and period
Promise with task ID for checking batch task result
Batch edit products open campaign setting
Use this API to edit settings for multiple products in the open campaign.
Parameters including campaign IDs and new settings
Promise with task ID for checking batch task result
Batch get products suggested rate
Use this API to get suggested commission rates for multiple products.
Parameters with item ID list
Promise with suggested rates for each item
Batch remove products open campaign setting
Use this API to remove multiple products from the open campaign.
Parameters with campaign IDs to remove
Promise with task ID for checking batch task result
Create a new targeted campaign
Use this API to create a targeted campaign with specific products and affiliates.
Campaign details including name, period, items, and affiliates
Promise with created campaign ID and any failed items/affiliates
Edit affiliate list of targeted campaign
Use this API to add or remove affiliates from a targeted campaign.
Campaign ID, edit type (add/remove), and affiliate list
Promise with campaign ID and any failed affiliates
Edit all products open campaign setting
Use this API to edit settings for all products in the open campaign.
Parameters with new commission rate and period
Promise with task ID for checking batch task result
Edit product list of targeted campaign
Use this API to add, remove, or edit products in a targeted campaign.
Campaign ID, edit type (add/remove/edit), and item list
Promise with campaign ID and any failed items
Get affiliate performance
Use this API to get performance data by affiliate.
Period type, date range, and pagination parameters
Promise with affiliate performance data
Get auto add new product toggle status
Use this API to check if auto-add new product feature is enabled.
Promise with toggle status and commission rate
Get campaign key metrics performance
Use this API to get overall key metrics for campaigns.
Period type and date range
Promise with aggregated performance metrics
Get content performance
Use this API to get performance data by content.
Period type, date range, and pagination parameters
Promise with content performance data
Get conversion report
Use this API to get detailed conversion data with optional filters.
Optionalparams: GetConversionReportParamsPagination and filter parameters
Promise with conversion report data
Get managed affiliate list
Use this API to get the list of affiliates managed by the shop.
Optionalparams: GetManagedAffiliateListParamsPagination parameters
Promise with list of managed affiliates
Get open campaign added product list
Use this API to get the list of products added to the open campaign.
Pagination and search parameters
Promise with list of added products
Get open campaign batch task result
Use this API to check the status and result of a batch operation.
Parameters with task ID
Promise with task status and results
Get open campaign not added product list
Use this API to get products that are not yet added to the open campaign.
Pagination and search parameters
Promise with list of not added products
Get open campaign performance
Use this API to get performance data for the open campaign.
Period type, date range, and pagination parameters
Promise with performance data
Get optimization suggestion product
Use this API to get products with optimization suggestions.
Optionalparams: GetOptimizationSuggestionProductParamsPagination and filter parameters
Promise with products and their suggested optimizations
Get performance data update time
Use this API to get the latest data date for performance data.
Marker type (e.g., AmsMarker)
Promise with latest data date
Get product performance
Use this API to get performance data by product.
Period type, date range, and pagination parameters
Promise with product performance data
Get recommended affiliate list
Use this API to get a list of recommended affiliates for the shop.
Optionalparams: GetRecommendedAffiliateListParamsPage size parameter
Promise with list of recommended affiliates
Get shop performance
Use this API to retrieve overall key metrics for all channels or specific channels.
Period type, date range, order type, and channel
Promise with shop-level performance metrics
Get shop suggested rate
Use this API to get the suggested commission rate for the shop.
Promise with suggested rate and rate range
Get targeted campaign addable product list
Use this API to get products that can be added to targeted campaigns.
Pagination and search parameters
Promise with list of addable products
Get targeted campaign list
Use this API to get a list of targeted campaigns with optional filters.
Optionalparams: GetTargetedCampaignListParamsPagination and filter parameters
Promise with list of campaigns
Get targeted campaign performance
Use this API to get performance data for targeted campaigns.
Period type, date range, and pagination parameters
Promise with campaign performance data
Get targeted campaign settings
Use this API to get detailed settings of a specific targeted campaign.
Campaign ID
Promise with campaign settings including items and affiliates
Get validation list
Use this API to get the list of validation periods.
Promise with list of validation periods
Get validation report
Use this API to get detailed validation report data.
Optionalparams: GetValidationReportParamsPagination and filter parameters
Promise with validation report data
Query affiliate list
Use this API to search for affiliates by ID or name.
Query type (id/name) and search criteria
Promise with matching affiliates
Remove all products from open campaign
Use this API to remove all products from the open campaign.
Promise with task ID for checking batch task result
Terminate targeted campaign
Use this API to terminate an active targeted campaign.
Campaign ID to terminate
Promise with terminated campaign ID
Update auto add new product setting
Use this API to enable/disable and configure auto-add new product feature.
Toggle status and commission rate
Promise with empty response on success
Update basic info of targeted campaign
Use this API to update basic information of a targeted campaign.
Campaign ID and fields to update
Promise with updated campaign ID
AMS (Affiliate Marketing Solution) Manager
This manager provides methods for managing affiliate marketing campaigns, including open campaigns, targeted campaigns, performance tracking, and affiliate management.