{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AcceptLanguageHeaderOptional":{"description":"Specifies the preferred language for response content","in":"header","name":"Accept-Language","schema":{"type":"string"}},"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":{"AdProduct":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |","enum":["SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"],"type":"string"},"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"},"CampaignLaunchFulfilmentCriterion":{"properties":{"endDateTime":{"description":"The deadline by which advertisers must create the corresponding campaign in order to qualify for the promotion offer.","format":"date-time","type":"string"},"startDateTime":{"description":"The date from which advertisers must create the corresponding campaign in order to qualify for the promotion offer.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/CriterionStatus"}},"required":["endDateTime","startDateTime","status"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CriterionStatus":{"enum":["COMPLETED","IN_PROGRESS","NOT_STARTED"],"type":"string"},"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"},"FulfilmentCriterion":{"oneOf":[{"properties":{"campaignLaunchFulfilmentCriterion":{"$ref":"#/components/schemas/CampaignLaunchFulfilmentCriterion"}},"required":["campaignLaunchFulfilmentCriterion"],"title":"campaignLaunchFulfilmentCriterion","type":"object"},{"properties":{"spendsFulfilmentCriterion":{"$ref":"#/components/schemas/SpendsFulfilmentCriterion"}},"required":["spendsFulfilmentCriterion"],"title":"spendsFulfilmentCriterion","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"},"PromotionCampaign":{"description":"Represents a promotional campaign that offers click credits to advertisers based on meeting specific spending thresholds within a defined timeframe. Supports both single-tier and multi-tier reward structures for different ad products and marketplaces.","properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"title":{"description":"Title of the promotion campaign.","type":"string"},"tncUrl":{"description":"The Url of the Terms and condition page for the promotion campaign.","type":"string"}},"required":["adProduct","title","tncUrl"],"type":"object"},"PromotionOffer":{"properties":{"accountId":{"description":"The account id for which the promotion offer is created. Only supports global advertiser account id.","type":"string"},"description":{"description":"Description of the promotion offer.","type":"string"},"fulfilmentCriteria":{"description":"The fulfilment criteria of the promotion offer. Can include up to two criteria: a CampaignLaunchFulfilmentCriterion and a SpendsFulfilmentCriterion. For example, a promotion offer might require launching a Sponsored Products campaign first, and then spending $500 within 30 days to receive a $300 reward, or could just require launching a Sponsored Products campaign only.","items":{"$ref":"#/components/schemas/FulfilmentCriterion"},"maxItems":2,"minItems":1,"type":"array"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"promotionCampaign":{"$ref":"#/components/schemas/PromotionCampaign"},"promotionOfferId":{"description":"The unique identifier of the promotion offer.","type":"string"},"promotionRewardId":{"description":"The promotion reward Id associated to the promotion offer.","type":"string"},"status":{"$ref":"#/components/schemas/PromotionOfferStatus"}},"required":["accountId","description","fulfilmentCriteria","marketplace","promotionCampaign","promotionOfferId","status"],"type":"object"},"PromotionOfferMarketplaceFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionOfferPromotionOfferStatusFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/PromotionOfferStatus"},"maxItems":4,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"PromotionOfferStatus":{"enum":["AVAILABLE","IN_PROGRESS","MISSED","REWARDED"],"type":"string"},"PromotionOfferSuccessResponse":{"properties":{"contentLanguage":{"type":"string"},"nextToken":{"type":"string"},"promotionOffers":{"items":{"$ref":"#/components/schemas/PromotionOffer"},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"required":["contentLanguage"],"type":"object"},"QueryPromotionOfferRequest":{"properties":{"marketplaceFilter":{"$ref":"#/components/schemas/PromotionOfferMarketplaceFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"statusFilter":{"$ref":"#/components/schemas/PromotionOfferPromotionOfferStatusFilter"}},"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SpendsFulfilmentCriterion":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"endDateTime":{"description":"The deadline by which the spend threshold must be met. This is only populated after the campaign is launched.","format":"date-time","type":"string"},"spend":{"description":"The current amount spent by the advertiser towards meeting the spend threshold. This is only populated after the campaign is launched.","format":"double","type":"number"},"startDateTime":{"description":"The date from which advertiser spends start being tracked towards the threshold. This is only populated after the campaign is launched.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/CriterionStatus"},"tiers":{"description":"Different spend threshold tiers with corresponding reward amounts associated to the same promotion offer.","items":{"$ref":"#/components/schemas/SpendsTier"},"maxItems":3,"minItems":1,"type":"array"}},"required":["currencyCode","status","tiers"],"type":"object"},"SpendsTier":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"description":{"description":"The description of the spending tier.","type":"string"},"reward":{"description":"The click credits amount to be rewarded when this tier\u0027s threshold is met.","format":"double","type":"number"},"threshold":{"description":"The minimum spend amount required for this tier.","format":"double","type":"number"}},"required":["currencyCode","description","reward","threshold"],"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":"PromotionOffers API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/query/promotionOffers":{"post":{"description":"API to list the promotion offers for a global account\n\n**Requires one of these permissions**:\n[\"nemo_transactions_view\", \"nemo_transactions_edit\"]","operationId":"QueryPromotionOffer","parameters":[{"$ref":"#/components/parameters/AcceptLanguageHeaderOptional"},{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPromotionOfferRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionOfferSuccessResponse"}}},"description":"QueryPromotionOffer 200 response","headers":{"Content-Language":{"required":true,"schema":{"type":"string"}}}},"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":["PromotionOffers"]}}},"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"}]}