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
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
page_size | Page size, Maximum 50 | Yes | integer | 20 |
page | Page | Yes | integer | 1 |
default_filter | Default filter, 0 = will return all products, 1 = will return products with a partnership and FBA logistics | No | integer | 0 |
country_code | Country filter, US,MX,CA,DE,UK,ES,FR,IT,NL | No | string | - |
brand_id | Brand ID, Not supported for bulk | No | integer | - |
sort | 1 = best selling , 2 = most discount, 3 = best coupon | No | integer | - |
asins | ASIN, Maximum of 50, seperated by comma | No | string | - |
relationship | Relationship, 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. | No | integer | 1 |
is_original_currency | Whether 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. | No | integer | 0 |
has_promo_code | Whether to only return the promo code product, 0 = return all products, 1 = returns only products with a promo code | No | integer | 0 |
has_acc | Whether to only return the amazon creator connection, 0 = return all products, 1 = returns only products with a amazon creator connection | No | integer | 0 |
filter_sexual_wellness | Default = 0 0 = Do not filter products under the category Health & Household → Sexual Wellness 1 = Filter products under the category Health & Household → Sexual Wellness | No | integer | 0 |
uid | PartnerBoost UID, Maximum 5, seperated by comma, Maximum length is 100 | No | string | - |
return_link | Whether to return PartnerBoost short link, 0 = do not return (default), 1 = will return | No | integer | 0 |
return_performance_bonus | Whether to return the performance bonus, 0=no, 1=yes | No | integer | 0 |
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
| Key | Description | Type | Example |
|---|---|---|---|
status.code | - | integer | 0 |
status.msg | - | string | success |
data.list[].product_id | Product ID | string | 007d030d256e3e35774d65822f89c778 |
data.list[].product_name | Product name | string | Midea MERC07C4BAWW 7.0 Cubic Feet Chest Freezer Cu.ft-Convertible, White 7.0 Cu.ft-Convertible |
data.list[].image | Product image | string | https://m.media-amazon.com/images/I/21iIQfKFRmL._SS500_.jpg |
data.list[].asin | ASIN | string | B0CQT26VCW |
data.list[].discount | Discount, Discount percentage | string | 0% |
data.list[].discount_code | Coupon code | string | - |
data.list[].coupon | Clip Coupon, Could be a percentage or a price value | string | - |
data.list[].commission | Commission, Could be a percentage or flat fee | string | 10% |
data.list[].category | Main category | string | Appliances |
data.list[].subcategory | Subcategory | string | Chest Freezers |
data.list[].parent_asin | Parent ASIN | string | B0DK1Z5TLX |
data.list[].variant_asin | Variant ASIN | string | B0CQT1JGQQ,B00MVVITWC,B0CQT2VXS8 |
data.list[].availability | Availability, Only return in_stock product for now | string | IN_STOCK |
data.list[].rating | Average rating | string | 4.4 |
data.list[].reviews | Number of reviews | string | 10196 |
data.list[].url | - | string | https://www.amazon.com/dp/B0CQT26VCW |
data.list[].brand_id | Brand ID | string | 90863 |
data.list[].brand_name | Brand name | string | Midea_US |
data.list[].update_time | Updated time, yyyy-MM-dd | string | 2025-03-18 |
data.list[].country_code | Country code, US,MX,CA,DE,UK,ES,FR,IT,NL | string | US |
data.list[].relationship | Relationship, 0 = returns products with no partnership, 1 = returns only products with a partnership. | integer | 1 |
data.list[].original_price | Original price, Accurate to 2 decimal places | string | $269.99 |
data.list[].discount_price | Discount price, Accurate to 2 decimal places | string | $269.99 |
data.list[].currency | Currency, The currency of original_price, discount_price, and commission. | string | USD |
data.list[].acc_commission | Amazon Creator Connection commission rate. | string | 23% |
data.list[].acc_start_date | ISO 8601. | string | 2025-07-21T00:00:00-07:00 |
data.list[].acc_end_date | ISO 8601. | string | 2025-07-31T00:00:00-07:00 |
data.list[].promo_code_list[].promotion_title | Promotion Title | string | 5% OFF for May Special |
data.list[].promo_code_list[].tracking_id | Tracking ID | string | MPC-S Percentage Off... |
data.list[].promo_code_list[].promo_code | Promo Code | string | DFGFDG |
data.list[].promo_code_list[].buyer_gets | Discount Percentage for Buyer | string | 0.2 |
data.list[].promo_code_list[].promo_code_start_time | ISO 8601 | string | 2025-04-08T15:30:00-07:00 |
data.list[].promo_code_list[].promo_code_end_time | ISO 8601 | string | 2025-04-18T15:30:00-07:00 |
data.list[].promo_code_list[].redemptions_per_customer | 1 = One unit in one checkout 2 = Unlimited units in one checkout 3 = Unlimited units in unlimited checkouts | integer | 1 |
data.list[].promo_code_list[].can_combine_with_coupon | Can this promo code be used together with a coupon promotion? true = Yes false = No | boolean | false |
data.list[].promo_code_list[].promotional_price | The price of the item after applying the promo code. | string | $199.99 |
data.list[].link | Amazon Attribution Link | string | https://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_link | PartnerBoost Attribution Link | string | - |
data.list[].link_id | Link ID | string | 2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c |
data.list[].performance_bonus.enabled | Whether the performance bonus is currently active (status=1) | boolean | true |
data.list[].performance_bonus.bonus_type | Type of bonus value. 'percentage' = bonus_value is a %; 'fixed_amount' = bonus_value is a dollar amount | string | percentage |
data.list[].performance_bonus.bonus_paid_as | How 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 tier | string | for_each_order |
data.list[].performance_bonus.tier_based_on | What metric the tier thresholds are evaluated against. 'sales_amount' = total USD sales; 'order_numbers' = total number of orders | string | sales_amount |
data.list[].performance_bonus.time_period | Window over which the metric is accumulated. 'per_month' = resets each calendar month; other values (e.g. 'total') = lifetime cumulative | string | per_month |
data.list[].performance_bonus.description | Human-readable summary of the bonus rules, auto-generated from tiers. Multiple tiers are space-separated. | string | If sales amount reach $34 per month then give additional 12% bonus for each order. |
data.list[].performance_bonus.tiers[].threshold | Minimum 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' | number | 34 |
data.list[].performance_bonus.tiers[].bonus_value | Bonus amount for this tier. Interpreted as a percentage when bonus_type='percentage', or as a fixed dollar amount when bonus_type='fixed_amount' | number | 12 |
data.has_more | Is there more data? | boolean | true |
getFbaProductsLink
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
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
product_ids | Product ID, support multiple product ID, seperated by comma | Yes | string | 007d030d256e3e35774d65822f89c778 |
uid | PartnerBoost UID, Maximum 5, seperated by comma, Maximum length is 100 | No | string | 123 |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"product_ids": "007d030d256e3e35774d65822f89c778",
"uid": "123"
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data.product_id | Product ID | string | 007d030d256e3e35774d65822f89c778 |
data.link | Amazon Attribution Link | string | https://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_id | Link ID | string | 5a19kG_aIdGFJrujZS3rjehf1RoROk2O8_bveeZQSggsULwwlmW2JT7vMOckEw0A_a1I_bNTErmMiVHobJT9S53Tvx7WFDtBnEGLhIcLwA8_c |
error_list.product_id | Product ID | string | 111 |
error_list.message | Error message | string | Product 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
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
asins | ASIN, Maximum of 50, seperated by comma | Yes | string | B0CQT26VCW |
country_code | Country code, US,MX,CA,DE,UK,ES,FR,IT,NL | Yes | string | US |
uid | PartnerBoost UID, Maximum 5, seperated by comma, Maximum length is 100 | No | string | - |
return_partnerboost_link | Whether to return PartnerBoost short link, 0 = do not return (default), 1 = will return | No | integer | 0 |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"asins": "B0CQT26VCW",
"country_code": "US",
"return_partnerboost_link": 0
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data.asin | ASIN | string | B0CQT26VCW |
data.link | Amazon Attribution Link | string | https://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_link | PartnerBoost Attribution Link | string | - |
data.link_id | Link ID | string | 2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c |
error_list.asin | ASIN | string | B0CQ2JMS731 |
error_list.country_code | country code | string | US |
error_list.message | Error message | string | Product 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
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
bids | Brand ID, Maximum of 100, seperated by comma | Yes | string | 90863 |
page_size | Page size, Maximum 100 | No | integer | 20 |
page | Page | No | integer | 1 |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"bids": "90863",
"page_size": 20,
"page": 1
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data.bid | Brand ID | string | 90863 |
data.brand_name | Brand name | string | Midea_US |
data.support_storefront_link | Does it support brand link tracking ,yes or no | string | yes |
data.country | country code | string | US |
getFbaBrandLink
This API allows you to generate storefront tracking links using the brand ID.
Method: POST
Path: /api/datafeed/get_fba_brand_link
Request parameters
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
bids | Brand ID, Maximum of 50, seperated by comma | Yes | string | 90863 |
uid | uid, Maximum 5, seperated by comma, Maximum length is 100 | No | string | zxf |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"bids": "90863",
"uid": "zxf"
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data.bid | Brand ID | string | 90863 |
data.brand_name | Brand name | string | Midea_US |
data.storefront_link | Amazon Attribution Link(Storefront) | string | https://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_link | Short Link(Storefront) | string | https://pboost.me/JqLDkvht?uid=zxf |
data.link_id | Link ID | string | 2356UTnKtRt_atVWUJCB5mBgYP6bhTuU91YCLgLd4zZQclplXKUty8YgXL5jjRlmjAbAnmAIFPb8q8JDGvvng99S903nog6k_c |
data.country | country code | string | US |
error_list.bid | Brand ID | string | 77 |
error_list.brand_name | Brand name | string | - |
error_list.message | error message | string | Bid 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
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
link_ids | Link ID, Maximum of 50, seperated by comma | Yes | string | 2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"link_ids": "2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c"
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data.link_id | Link ID | string | 2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c |
data.active | Is the promotional link valid? True or false | boolean | true |
data.asin | ASIN | string | B0CQT26VCW |
data.brand_id | Brand ID | integer | 90863 |
data.link | Amazon Attribution Link | string | https://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.country | Country code, US,MX,CA,DE,UK,ES,FR,IT,NL | string | US |
data.type | Link type, Product or storefront | string | product |
data.uid | uid, Maximum 5, seperated by comma, Maximum length is 100 | string | - |
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
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
page_size | Page size, Maximum 200,default at 100 | Yes | integer | 100 |
page | Page | Yes | integer | 1 |
start_date | Start date, Format: YYYYMMDD 20240106 start_date can be a maximum of 1 year part from end_date | Yes | string | 20241201 |
end_date | End date, Format: YYYYMMDD 20240106 end_date can be a maximum of 1 year part from start_date | Yes | string | 20241202 |
marketplace | Amazon marketplace for different countries, US,MX,CA,DE,UK,ES,FR,IT,NL | No | string | - |
asins | ASIN, Maximum 50, seperated by comma | No | string | - |
adGroupIds | adGroupId, Maximum 10, seperated by comma | No | string | - |
order_ids | order_id, Maximum 100, seperated by comma | No | string | - |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"page_size": 100,
"page": 1,
"start_date": "20241201",
"end_date": "20241202"
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data.list[].asin | ASIN | string | B0C6DHK68Q |
data.list[].date | Date for the data, 20240409 | string | 20241202 |
data.list[].marketplace | Marketplace | string | US |
data.list[].currency | All reporting is caluculated in USD | string | USD |
data.list[].estCommission | Commission, Accurate to 2 decimal places | string | 0 |
data.list[].sales | Sales, Accurate to 2 decimal places | string | 0 |
data.list[].quantity | Quantity | integer | 0 |
data.list[].conversionRate | Conversion Rate, quantity/detailPageViews, Accurate to 2 decimal places | string | 0.00% |
data.list[].clicks | Clicks | integer | 4 |
data.list[].addToCarts | addToCarts | integer | 0 |
data.list[].detailPageViews | detailPageViews | integer | 2 |
data.list[].productConversionType | Conversion Type, Promoted or Brand Halo | string | Promoted |
data.list[].link | Amazon Attribution Link | string | https://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[].uid | Custom ID | string | sherry |
data.list[].adGroupId | adGroupId | string | a6e3PBLq_ayRy2ZHjkvNvuSc3HqaLxHWh7tZO1jvSwkhTmyEsUJtgQga1fQOAqndyCMTs_aBKOVU6OLQmWZeLPfEGF9URtJkGJAQEXdWdQjhj5U2Jv7PmcjWf1Wgw6UYyiGHT3WvI_c |
data.list[].order_id | order id | string | C1TIP-PJ09161555 |
data.has_more | if there's more data | boolean | true |
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
| Key | Description | Required | Type | Example |
|---|---|---|---|---|
token | Acquired from publisher portal | Yes | string | - |
page_size | Page size, Maximum 200,default at 200 | Yes | integer | 200 |
page | Page | Yes | integer | 1 |
return_performance_bonus | Whether to return the performance bonus, 0=no, 1=yes | Yes | integer | 0 |
Request:
{
"token": "YOUR_CHANNEL_TOKEN",
"page_size": 200,
"page": 1,
"return_performance_bonus": 0
}
Response fields
| Key | Description | Type | Example |
|---|---|---|---|
status.code | Status code, 0=success | integer | 0 |
status.msg | - | string | success |
data.list[].bid | Brand ID | integer | 73237 |
data.list[].brand_name | Brand Name | string | cololight |
data.list[].asin | ASIN | string | B0C6DHK68Q |
data.list[].commission | Commission Rate, means 15% commission | number | 0.15 |
data.list[].start_date | Commission start time | string | 2025-10-09T10:00:00-07:00 |
data.list[].end_date | Commission end time | string | 2025-10-19T11:00:00-07:00 |
data.list[].acc_campaign_id | Amazon Creator Connection Campaign ID. | string | amzn1.campaign.3ABT368W9RO04 |
data.list[].acc_commission_rate | Amazon Creator Connection Campaign Commission Rate, means 12% commission. | string | 0.12 |
data.list[].acc_start_date | Amazon Creator Connection Campaign start date | string | 2025-08-01 |
data.list[].acc_end_date | Amazon Creator Connection Campaign end date | string | 2025-12-31 |
data.list[].acc_budget | Amazon Creator Connection Campaign budget | string | 10000 |
data.list[].acc_spend | Amazon Creator Connection Campaign spend | string | 518 |
data.list[].acc_currency | Amazon Creator Connection Campaign currency, All of them are USD | string | USD |
data.list[].performance_bonus.enabled | Whether the performance bonus is currently active (status=1) | boolean | true |
data.list[].performance_bonus.bonus_type | Type of bonus value. 'percentage' = bonus_value is a %; 'fixed_amount' = bonus_value is a dollar amount | string | percentage |
data.list[].performance_bonus.bonus_paid_as | How 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 tier | string | for_each_order |
data.list[].performance_bonus.tier_based_on | What metric the tier thresholds are evaluated against. 'sales_amount' = total USD sales; 'order_numbers' = total number of orders | string | sales_amount |
data.list[].performance_bonus.time_period | Window over which the metric is accumulated. 'per_month' = resets each calendar month; other values (e.g. 'total') = lifetime cumulative | string | per_month |
data.list[].performance_bonus.description | Human-readable summary of the bonus rules, auto-generated from tiers. Multiple tiers are space-separated. | string | If sales amount reach $34 per month then give additional 12% bonus for each order. |
data.list[].performance_bonus.tiers[].threshold | Minimum 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' | number | 34 |
data.list[].performance_bonus.tiers[].bonus_value | Bonus amount for this tier. Interpreted as a percentage when bonus_type='percentage', or as a fixed dollar amount when bonus_type='fixed_amount' | number | 12 |
data.has_more | if there's more data | boolean | true |