{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeader":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CurrencyCode":{"description":"**CurrencyCode Enum:**\n| CurrencyCode | Description |\n| --- | --- |\n| `AED` | United Arab Emirates Dirham |\n| `AUD` | Australian Dollar |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `CLP` | Chilean Peso |\n| `COP` | Colombian Peso |\n| `EGP` | Egyptian Pound |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `INR` | Indian Rupee |\n| `JPY` | Japanese Yen |\n| `MXN` | Mexican Peso |\n| `NGN` | Nigerian Naira |\n| `PLN` | Polish Złoty |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `TRY` | Turkish Lira |\n| `USD` | United States Dollar |\n| `ZAR` | South African Rand |","enum":["AED","AUD","BRL","CAD","CLP","COP","EGP","EUR","GBP","INR","JPY","MXN","NGN","PLN","SAR","SEK","SGD","TRY","USD","ZAR"],"type":"string"},"ErrorCode":{"description":"**ErrorCode Enum:**\n| ErrorCode | Description |\n| --- | --- |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n| `INVALID_PROMOTION_CODE` | The promotion code is invalid or does not exist. |\n| `EXPIRED_PROMOTION_CODE` | The promotion code has expired. |\n| `MAXIMUM_REDEMPTIONS_REACHED` | Maximum redemptions for the advertiser account reached for the promotion code. |\n| `ACCOUNT_NOT_ELIGIBLE` | The advertiser account does not meet the eligibility criteria for the promotion code. |","enum":["ACCOUNT_NOT_ELIGIBLE","BAD_REQUEST","EXPIRED_PROMOTION_CODE","INTERNAL_ERROR","INVALID_PROMOTION_CODE","MAXIMUM_REDEMPTIONS_REACHED","TOO_MANY_REQUESTS","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Marketplace":{"description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NG","NL","PL","SA","SE","SG","TR","US","ZA"],"type":"string"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"PromotionReward":{"properties":{"advertiserAccountId":{"description":"The advertiser account associated with the promotion reward.","type":"string"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"endDateTime":{"description":"The date and time by which the promotion reward expires.","format":"date-time","type":"string"},"includePromotionRewardConsumption":{"description":"Whether per-invoice consumption details are included in the response.","type":"boolean"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"name":{"description":"The display name of the promotion reward.","type":"string"},"promotionRewardConsumptions":{"description":"The per-invoice consumption details of the promotion reward.","items":{"$ref":"#/components/schemas/PromotionRewardConsumption"},"maxItems":50,"minItems":0,"type":"array"},"promotionRewardId":{"description":"A unique identifier for the promotion reward.","type":"string"},"promotionRewardType":{"$ref":"#/components/schemas/PromotionRewardType"},"remainingReward":{"description":"The click credits amount of the promotion reward not yet consumed.","format":"double","type":"number"},"reward":{"description":"The total click credits amount of the promotion reward.","format":"double","type":"number"},"startDateTime":{"description":"The date and time from which the promotion reward is active and eligible for consumption.","format":"date-time","type":"string"}},"required":["advertiserAccountId","currencyCode","endDateTime","marketplace","name","promotionRewardId","promotionRewardType","remainingReward","reward","startDateTime"],"type":"object"},"PromotionRewardConsumption":{"description":"The consumption of a promotion reward against a specific invoice.","properties":{"consumedReward":{"description":"The click credits amount of the promotion reward applied to this invoice.","format":"double","type":"number"},"invoiceId":{"description":"The invoice against which the promotion reward was applied. Null only for in-progress consumption that has not yet been settled to an invoice; once an invoice is issued, this is always populated. Consumers should treat null as a \u0027pending invoice\u0027 state.","type":"string"}},"required":["consumedReward"],"type":"object"},"PromotionRewardEndDateTimeFilter":{"properties":{"include":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardIncludePromotionRewardConsumptionFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardMarketplaceFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":28,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardPromotionRewardIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardPromotionRewardTypeFilter":{"properties":{"include":{"description":"**PromotionRewardType Enum:**\n| PromotionRewardType | Description |\n| --- | --- |\n| `ADHOC` | A direct promotion reward applied to an advertiser account. |\n| `SIGNUP` | A promotion reward awarded upon advertiser signup. |\n| `PROMO_CODE` | A promotion reward redeemed via a promotion code. |","items":{"$ref":"#/components/schemas/PromotionRewardType"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardStartDateTimeFilter":{"properties":{"include":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionRewardSuccessResponse":{"properties":{"nextToken":{"type":"string"},"promotionRewards":{"items":{"$ref":"#/components/schemas/PromotionReward"},"maxItems":25,"minItems":0,"type":"array"}},"type":"object"},"PromotionRewardType":{"description":"The type of a promotion reward.\n**PromotionRewardType Enum:**\n| PromotionRewardType | Description |\n| --- | --- |\n| `ADHOC` | A direct promotion reward applied to an advertiser account. |\n| `SIGNUP` | A promotion reward awarded upon advertiser signup. |\n| `PROMO_CODE` | A promotion reward redeemed via a promotion code. |","enum":["ADHOC","PROMO_CODE","SIGNUP"],"type":"string"},"QueryPromotionRewardRequest":{"properties":{"endDateTimeFilter":{"$ref":"#/components/schemas/PromotionRewardEndDateTimeFilter"},"includePromotionRewardConsumptionFilter":{"$ref":"#/components/schemas/PromotionRewardIncludePromotionRewardConsumptionFilter"},"marketplaceFilter":{"$ref":"#/components/schemas/PromotionRewardMarketplaceFilter"},"maxResults":{"default":25,"format":"int32","maximum":25,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"promotionRewardIdFilter":{"$ref":"#/components/schemas/PromotionRewardPromotionRewardIdFilter"},"promotionRewardTypeFilter":{"$ref":"#/components/schemas/PromotionRewardPromotionRewardTypeFilter"},"startDateTimeFilter":{"$ref":"#/components/schemas/PromotionRewardStartDateTimeFilter"}},"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p_ALL.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p_ALL.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p_ALL.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p_ALL.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p_ALL.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p_ALL.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p_ALL.json))","title":"PromotionRewards API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/query/promotionRewards":{"post":{"description":"Query promotion rewards for an advertiser account. Returns reward details including type, amounts, consumption tracking, and linked account information.\n\n**Requires one of these permissions**:\n[\"nemo_transactions_view\", \"nemo_transactions_edit\"]","operationId":"QueryPromotionReward","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPromotionRewardRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionRewardSuccessResponse"}}},"description":"QueryPromotionReward 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["PromotionRewards"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}