跳到主要内容

Amazon

Base URL:

https://app.partnerboost.com

All endpoints use POST with Content-Type: application/json unless noted otherwise. Auth: Partner API authentication — pass token in the JSON body (from the publisher portal).

getFbaProducts

This API allows you to filter and search for Amazon products that meet specific criteria, helping to narrow down the selection.

Method: POST
Path: /api/datafeed/get_fba_products

Request parameters

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
page_sizePage size, Maximum 50Yesinteger20
pagePageYesinteger1
default_filterDefault filter, 0 = will return all products, 1 = will return products with a partnership and FBA logisticsNointeger0
country_codeCountry filter, US,MX,CA,DE,UK,ES,FR,IT,NLNostring-
brand_idBrand ID, Not supported for bulkNointeger-
sort1 = best selling , 2 = most discount, 3 = best couponNointeger-
asinsASIN, Maximum of 50, seperated by commaNostring-
relationshipRelationship, 0 = returns products with no partnership, 1 = returns only products with a partnership, 2 = returns all products that meet the criteria, regardless of partnership status.Nointeger1
is_original_currencyWhether to return the original currency, 0 = Convert original_price, discount_price, and commission amounts into USD. 1 = Keep original_price, discount_price, and commission in the Amazon store's currency and amounts.Nointeger0
has_promo_codeWhether to only return the promo code product, 0 = return all products, 1 = returns only products with a promo codeNointeger0
has_accWhether to only return the amazon creator connection, 0 = return all products, 1 = returns only products with a amazon creator connectionNointeger0
filter_sexual_wellnessDefault = 0 0 = Do not filter products under the category Health & Household → Sexual Wellness 1 = Filter products under the category Health & Household → Sexual WellnessNointeger0
uidPartnerBoost UID, Maximum 5, seperated by comma, Maximum length is 100Nostring-
return_linkWhether to return PartnerBoost short link, 0 = do not return (default), 1 = will returnNointeger0
return_performance_bonusWhether to return the performance bonus, 0=no, 1=yesNointeger0

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"page_size": 20,
"page": 1,
"default_filter": 0,
"brand_id": null,
"relationship": 1,
"is_original_currency": 0,
"has_promo_code": 0,
"has_acc": 0,
"filter_sexual_wellness": 0,
"return_link": 0,
"return_performance_bonus": 0
}

Response fields

KeyDescriptionTypeExample
status.code-integer0
status.msg-stringsuccess
data.list[].product_idProduct IDstring007d030d256e3e35774d65822f89c778
data.list[].product_nameProduct namestringMidea MERC07C4BAWW 7.0 Cubic Feet Chest Freezer Cu.ft-Convertible, White 7.0 Cu.ft-Convertible
data.list[].imageProduct imagestringhttps://m.media-amazon.com/images/I/21iIQfKFRmL._SS500_.jpg
data.list[].asinASINstringB0CQT26VCW
data.list[].discountDiscount, Discount percentagestring0%
data.list[].discount_codeCoupon codestring-
data.list[].couponClip Coupon, Could be a percentage or a price valuestring-
data.list[].commissionCommission, Could be a percentage or flat feestring10%
data.list[].categoryMain categorystringAppliances
data.list[].subcategorySubcategorystringChest Freezers
data.list[].parent_asinParent ASINstringB0DK1Z5TLX
data.list[].variant_asinVariant ASINstringB0CQT1JGQQ,B00MVVITWC,B0CQT2VXS8
data.list[].availabilityAvailability, Only return in_stock product for nowstringIN_STOCK
data.list[].ratingAverage ratingstring4.4
data.list[].reviewsNumber of reviewsstring10196
data.list[].url-stringhttps://www.amazon.com/dp/B0CQT26VCW
data.list[].brand_idBrand IDstring90863
data.list[].brand_nameBrand namestringMidea_US
data.list[].update_timeUpdated time, yyyy-MM-ddstring2025-03-18
data.list[].country_codeCountry code, US,MX,CA,DE,UK,ES,FR,IT,NLstringUS
data.list[].relationshipRelationship, 0 = returns products with no partnership, 1 = returns only products with a partnership.integer1
data.list[].original_priceOriginal price, Accurate to 2 decimal placesstring$269.99
data.list[].discount_priceDiscount price, Accurate to 2 decimal placesstring$269.99
data.list[].currencyCurrency, The currency of original_price, discount_price, and commission.stringUSD
data.list[].acc_commissionAmazon Creator Connection commission rate.string23%
data.list[].acc_start_dateISO 8601.string2025-07-21T00:00:00-07:00
data.list[].acc_end_dateISO 8601.string2025-07-31T00:00:00-07:00
data.list[].promo_code_list[].promotion_titlePromotion Titlestring5% OFF for May Special
data.list[].promo_code_list[].tracking_idTracking IDstringMPC-S Percentage Off...
data.list[].promo_code_list[].promo_codePromo CodestringDFGFDG
data.list[].promo_code_list[].buyer_getsDiscount Percentage for Buyerstring0.2
data.list[].promo_code_list[].promo_code_start_timeISO 8601string2025-04-08T15:30:00-07:00
data.list[].promo_code_list[].promo_code_end_timeISO 8601string2025-04-18T15:30:00-07:00
data.list[].promo_code_list[].redemptions_per_customer1 = One unit in one checkout 2 = Unlimited units in one checkout 3 = Unlimited units in unlimited checkoutsinteger1
data.list[].promo_code_list[].can_combine_with_couponCan this promo code be used together with a coupon promotion? true = Yes false = Nobooleanfalse
data.list[].promo_code_list[].promotional_priceThe price of the item after applying the promo code.string$199.99
data.list[].linkAmazon Attribution Linkstringhttps://www.amazon.com/dp/B0CQT26VCW?maas=maas_adg_api_588397405087409390_static_12_201&ref_=aa_maas&aa_campaignid=7bb4254d6ba7ff445e3b8c3fd3ac9a98&aa_adgroupid=2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c&aa_creativeid=dac8duY81rA4IshIP_bqE2mv5Ytpr5sysBmRrTlNvZ_aqJJw_c_c
data.list[].partnerboost_linkPartnerBoost Attribution Linkstring-
data.list[].link_idLink IDstring2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c
data.list[].performance_bonus.enabledWhether the performance bonus is currently active (status=1)booleantrue
data.list[].performance_bonus.bonus_typeType of bonus value. 'percentage' = bonus_value is a %; 'fixed_amount' = bonus_value is a dollar amountstringpercentage
data.list[].performance_bonus.bonus_paid_asHow the bonus is disbursed. 'fixed_bonus' = one flat bonus once threshold is met; 'for_each_order' = bonus applied to every order once threshold is met; 'for_each_order_past_each_tier' = bonus applied per order for the portion of sales/orders beyond each tierstringfor_each_order
data.list[].performance_bonus.tier_based_onWhat metric the tier thresholds are evaluated against. 'sales_amount' = total USD sales; 'order_numbers' = total number of ordersstringsales_amount
data.list[].performance_bonus.time_periodWindow over which the metric is accumulated. 'per_month' = resets each calendar month; other values (e.g. 'total') = lifetime cumulativestringper_month
data.list[].performance_bonus.descriptionHuman-readable summary of the bonus rules, auto-generated from tiers. Multiple tiers are space-separated.stringIf sales amount reach $34 per month then give additional 12% bonus for each order.
data.list[].performance_bonus.tiers[].thresholdMinimum metric value to activate this tier. Interpreted as USD when tier_based_on='sales_amount', or as order count when tier_based_on='order_numbers'number34
data.list[].performance_bonus.tiers[].bonus_valueBonus amount for this tier. Interpreted as a percentage when bonus_type='percentage', or as a fixed dollar amount when bonus_type='fixed_amount'number12
data.has_moreIs there more data?booleantrue

This API allows you to generate product tracking links using the product IDs obtained from the Get Products API.

Method: POST
Path: /api/datafeed/get_fba_products_link

Request parameters

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
product_idsProduct ID, support multiple product ID, seperated by commaYesstring007d030d256e3e35774d65822f89c778
uidPartnerBoost UID, Maximum 5, seperated by comma, Maximum length is 100Nostring123

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"product_ids": "007d030d256e3e35774d65822f89c778",
"uid": "123"
}

Response fields

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data.product_idProduct IDstring007d030d256e3e35774d65822f89c778
data.linkAmazon Attribution Linkstringhttps://www.amazon.com/dp/B0CQT26VCW?maas=maas_adg_api_588397405087409390_static_12_201&ref_=aa_maas&aa_campaignid=7bb4254d6ba7ff445e3b8c3fd3ac9a98&aa_adgroupid=5a19kG_aIdGFJrujZS3rjehf1RoROk2O8_bveeZQSggsULwwlmW2JT7vMOckEw0A_a1I_bNTErmMiVHobJT9S53Tvx7WFDtBnEGLhIcLwA8_c&aa_creativeid=935buodNOa3UBB44KRoWnu_bYkP8_bMXt4ZTPVPghyBl19Qw_c_c
data.link_idLink IDstring5a19kG_aIdGFJrujZS3rjehf1RoROk2O8_bveeZQSggsULwwlmW2JT7vMOckEw0A_a1I_bNTErmMiVHobJT9S53Tvx7WFDtBnEGLhIcLwA8_c
error_list.product_idProduct IDstring111
error_list.messageError messagestringProduct not found or no relationship

getAmazonLinkByAsin

This API allows you to generate product tracking links using ASINs.

Method: POST
Path: /api/datafeed/get_amazon_link_by_asin

Request parameters

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
asinsASIN, Maximum of 50, seperated by commaYesstringB0CQT26VCW
country_codeCountry code, US,MX,CA,DE,UK,ES,FR,IT,NLYesstringUS
uidPartnerBoost UID, Maximum 5, seperated by comma, Maximum length is 100Nostring-
return_partnerboost_linkWhether to return PartnerBoost short link, 0 = do not return (default), 1 = will returnNointeger0

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"asins": "B0CQT26VCW",
"country_code": "US",
"return_partnerboost_link": 0
}

Response fields

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data.asinASINstringB0CQT26VCW
data.linkAmazon Attribution Linkstringhttps://www.amazon.com/dp/B0CQT26VCW?maas=maas_adg_api_588397405087409390_static_12_201&ref_=aa_maas&aa_campaignid=7bb4254d6ba7ff445e3b8c3fd3ac9a98&aa_adgroupid=2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c&aa_creativeid=dac8duY81rA4IshIP_bqE2mv5Ytpr5sysBmRrTlNvZ_aqJJw_c_c
data.partnerboost_linkPartnerBoost Attribution Linkstring-
data.link_idLink IDstring2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c
error_list.asinASINstringB0CQ2JMS731
error_list.country_codecountry codestringUS
error_list.messageError messagestringProduct not found or no relationship

getJoinedBrand

This API allows you to get joined amazon brands.

Method: POST
Path: /api/datafeed/get_amazon_joined_brands

Request parameters

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
bidsBrand ID, Maximum of 100, seperated by commaYesstring90863
page_sizePage size, Maximum 100Nointeger20
pagePageNointeger1

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"bids": "90863",
"page_size": 20,
"page": 1
}

Response fields

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data.bidBrand IDstring90863
data.brand_nameBrand namestringMidea_US
data.support_storefront_linkDoes it support brand link tracking ,yes or nostringyes
data.countrycountry codestringUS

This API allows you to generate storefront tracking links using the brand ID.

Method: POST
Path: /api/datafeed/get_fba_brand_link

Request parameters

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
bidsBrand ID, Maximum of 50, seperated by commaYesstring90863
uiduid, Maximum 5, seperated by comma, Maximum length is 100Nostringzxf

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"bids": "90863",
"uid": "zxf"
}

Response fields

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data.bidBrand IDstring90863
data.brand_nameBrand namestringMidea_US
data.storefront_linkAmazon Attribution Link(Storefront)stringhttps://www.amazon.com/stores/page/4F6A19CF-5B7B-4D5A-A739-6EA8B46D4560?maas=maas_adg_api_588397405087409390_static_12_201&ref_=aa_maas&aa_campaignid=7bb4254d6ba7ff445e3b8c3fd3ac9a98&aa_adgroupid=2356UTnKtRt_atVWUJCB5mBgYP6bhTuU91YCLgLd4zZQclplXKUty8YgXL5jjRlmjAbAnmAIFPb8q8JDGvvng99S903nog6k_c&aa_creativeid=637dieeq0c4i6ixtDSenAFsbhq2B_b8YIAKYX2k0DMMMlKw_c_c
data.storefront_short_linkShort Link(Storefront)stringhttps://pboost.me/JqLDkvht?uid=zxf
data.link_idLink IDstring2356UTnKtRt_atVWUJCB5mBgYP6bhTuU91YCLgLd4zZQclplXKUty8YgXL5jjRlmjAbAnmAIFPb8q8JDGvvng99S903nog6k_c
data.countrycountry codestringUS
error_list.bidBrand IDstring77
error_list.brand_nameBrand namestring-
error_list.messageerror messagestringBid not found or no relationship.

getAmazonLinkStatus

This API allows you to check if the promotion link is still trackable.

Method: POST
Path: /api/datafeed/get_amazon_link_status

Request parameters

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
link_idsLink ID, Maximum of 50, seperated by commaYesstring2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"link_ids": "2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c"
}

Response fields

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data.link_idLink IDstring2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c
data.activeIs the promotional link valid? True or falsebooleantrue
data.asinASINstringB0CQT26VCW
data.brand_idBrand IDinteger90863
data.linkAmazon Attribution Linkstringhttps://www.amazon.com/dp/B0CQT26VCW?maas=maas_adg_api_588397405087409390_static_12_201&ref_=aa_maas&aa_campaignid=7bb4254d6ba7ff445e3b8c3fd3ac9a98&aa_adgroupid=2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c&aa_creativeid=dac8duY81rA4IshIP_bqE2mv5Ytpr5sysBmRrTlNvZ_aqJJw_c_c
data.countryCountry code, US,MX,CA,DE,UK,ES,FR,IT,NLstringUS
data.typeLink type, Product or storefrontstringproduct
data.uiduid, Maximum 5, seperated by comma, Maximum length is 100string-

getAmazonReport

This API allows you to retrieve the order conversion report from the tracking link.

Method: POST
Path: /api/datafeed/get_amazon_report

Request parameters

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
page_sizePage size, Maximum 200,default at 100Yesinteger100
pagePageYesinteger1
start_dateStart date, Format: YYYYMMDD 20240106 start_date can be a maximum of 1 year part from end_dateYesstring20241201
end_dateEnd date, Format: YYYYMMDD 20240106 end_date can be a maximum of 1 year part from start_dateYesstring20241202
marketplaceAmazon marketplace for different countries, US,MX,CA,DE,UK,ES,FR,IT,NLNostring-
asinsASIN, Maximum 50, seperated by commaNostring-
adGroupIdsadGroupId, Maximum 10, seperated by commaNostring-
order_idsorder_id, Maximum 100, seperated by commaNostring-

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"page_size": 100,
"page": 1,
"start_date": "20241201",
"end_date": "20241202"
}

Response fields

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data.list[].asinASINstringB0C6DHK68Q
data.list[].dateDate for the data, 20240409string20241202
data.list[].marketplaceMarketplacestringUS
data.list[].currencyAll reporting is caluculated in USDstringUSD
data.list[].estCommissionCommission, Accurate to 2 decimal placesstring0
data.list[].salesSales, Accurate to 2 decimal placesstring0
data.list[].quantityQuantityinteger0
data.list[].conversionRateConversion Rate, quantity/detailPageViews, Accurate to 2 decimal placesstring0.00%
data.list[].clicksClicksinteger4
data.list[].addToCartsaddToCartsinteger0
data.list[].detailPageViewsdetailPageViewsinteger2
data.list[].productConversionTypeConversion Type, Promoted or Brand HalostringPromoted
data.list[].linkAmazon Attribution Linkstringhttps://www.amazon.com/dp/B0DFG2WDQH?maas=maas_adg_api_587256918045045545_static_12_201&ref_=aa_maas&aa_campaignid=9ed9b01b7ef4ea6c8bd5a019aaaf5e79&aa_adgroupid=a6e3PBLq_ayRy2ZHjkvNvuSc3HqaLxHWh7tZO1jvSwkhTmyEsUJtgQga1fQOAqndyCMTs_aBKOVU6OLQmWZeLPfEGF9URtJkGJAQEXdWdQjhj5U2Jv7PmcjWf1Wgw6UYyiGHT3WvI_c&aa_creativeid=8d72gyN8ZqN4r28Wlm7WXeNtleW707bz9P6AmNUgjuZuoNZ_c
data.list[].uidCustom IDstringsherry
data.list[].adGroupIdadGroupIdstringa6e3PBLq_ayRy2ZHjkvNvuSc3HqaLxHWh7tZO1jvSwkhTmyEsUJtgQga1fQOAqndyCMTs_aBKOVU6OLQmWZeLPfEGF9URtJkGJAQEXdWdQjhj5U2Jv7PmcjWf1Wgw6UYyiGHT3WvI_c
data.list[].order_idorder idstringC1TIP-PJ09161555
data.has_moreif there's more databooleantrue

getAccProductsList

This API allows you to filter and search for Amazon Creator Connection products.

Method: POST
Path: /api/datafeed/get_latest_acc_products

Request parameters

KeyDescriptionRequiredTypeExample
tokenAcquired from publisher portalYesstring-
page_sizePage size, Maximum 200,default at 200Yesinteger200
pagePageYesinteger1
return_performance_bonusWhether to return the performance bonus, 0=no, 1=yesYesinteger0

Request:

{
"token": "YOUR_CHANNEL_TOKEN",
"page_size": 200,
"page": 1,
"return_performance_bonus": 0
}

Response fields

KeyDescriptionTypeExample
status.codeStatus code, 0=successinteger0
status.msg-stringsuccess
data.list[].bidBrand IDinteger73237
data.list[].brand_nameBrand Namestringcololight
data.list[].asinASINstringB0C6DHK68Q
data.list[].commissionCommission Rate, means 15% commissionnumber0.15
data.list[].start_dateCommission start timestring2025-10-09T10:00:00-07:00
data.list[].end_dateCommission end timestring2025-10-19T11:00:00-07:00
data.list[].acc_campaign_idAmazon Creator Connection Campaign ID.stringamzn1.campaign.3ABT368W9RO04
data.list[].acc_commission_rateAmazon Creator Connection Campaign Commission Rate, means 12% commission.string0.12
data.list[].acc_start_dateAmazon Creator Connection Campaign start datestring2025-08-01
data.list[].acc_end_dateAmazon Creator Connection Campaign end datestring2025-12-31
data.list[].acc_budgetAmazon Creator Connection Campaign budgetstring10000
data.list[].acc_spendAmazon Creator Connection Campaign spendstring518
data.list[].acc_currencyAmazon Creator Connection Campaign currency, All of them are USDstringUSD
data.list[].performance_bonus.enabledWhether the performance bonus is currently active (status=1)booleantrue
data.list[].performance_bonus.bonus_typeType of bonus value. 'percentage' = bonus_value is a %; 'fixed_amount' = bonus_value is a dollar amountstringpercentage
data.list[].performance_bonus.bonus_paid_asHow the bonus is disbursed. 'fixed_bonus' = one flat bonus once threshold is met; 'for_each_order' = bonus applied to every order once threshold is met; 'for_each_order_past_each_tier' = bonus applied per order for the portion of sales/orders beyond each tierstringfor_each_order
data.list[].performance_bonus.tier_based_onWhat metric the tier thresholds are evaluated against. 'sales_amount' = total USD sales; 'order_numbers' = total number of ordersstringsales_amount
data.list[].performance_bonus.time_periodWindow over which the metric is accumulated. 'per_month' = resets each calendar month; other values (e.g. 'total') = lifetime cumulativestringper_month
data.list[].performance_bonus.descriptionHuman-readable summary of the bonus rules, auto-generated from tiers. Multiple tiers are space-separated.stringIf sales amount reach $34 per month then give additional 12% bonus for each order.
data.list[].performance_bonus.tiers[].thresholdMinimum metric value to activate this tier. Interpreted as USD when tier_based_on='sales_amount', or as order count when tier_based_on='order_numbers'number34
data.list[].performance_bonus.tiers[].bonus_valueBonus amount for this tier. Interpreted as a percentage when bonus_type='percentage', or as a fixed dollar amount when bonus_type='fixed_amount'number12
data.has_moreif there's more databooleantrue