{"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":{"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"},"CreatePromotionCodeRedemptionRequest":{"properties":{"promotionCodeRedemptions":{"items":{"$ref":"#/components/schemas/PromotionCodeRedemptionCreate"},"maxItems":5,"minItems":1,"type":"array"}},"required":["promotionCodeRedemptions"],"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"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"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":4,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"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"},"PromotionCodeRedemption":{"properties":{"accountId":{"description":"The account id for which promotion code redemption is created. Only supports global advertiser account id.","type":"string"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"promotionCodeId":{"description":"The promotion code ID associated with the promotion code redemption.","type":"string"},"promotionCodeRedemptionId":{"description":"The unique identifier of the promotion code redemption.","type":"string"},"redemptionResult":{"$ref":"#/components/schemas/RedemptionResult"}},"required":["accountId","marketplace","promotionCodeId","promotionCodeRedemptionId","redemptionResult"],"type":"object"},"PromotionCodeRedemptionCreate":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"promotionCodeId":{"description":"The promotion code ID associated with the promotion code redemption.","type":"string"}},"required":["marketplace","promotionCodeId"],"type":"object"},"PromotionCodeRedemptionMultiStatusResponse":{"properties":{"contentLanguage":{"type":"string"},"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":5,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/PromotionCodeRedemptionMultiStatusSuccess"},"maxItems":5,"minItems":0,"type":"array"}},"required":["contentLanguage"],"type":"object"},"PromotionCodeRedemptionMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":4,"minimum":0,"type":"integer"},"promotionCodeRedemption":{"$ref":"#/components/schemas/PromotionCodeRedemption"}},"required":["index","promotionCodeRedemption"],"type":"object"},"RedemptionResult":{"description":"Types of rewards that can be redeemed through a promotion code redemption.\n| RedemptionResult | Description |\n| --- | --- |\n| `promotionOffer` | A promotion offer that was redeemed. |","oneOf":[{"properties":{"promotionOffer":{"type":"string"}},"required":["promotionOffer"],"title":"promotionOffer","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":"PromotionCodeRedemptions API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/promotionCodeRedemptions":{"post":{"description":"API to create promotion code redemptions for affiliate codes\n\n**Requires one of these permissions**:\n[\"nemo_transactions_edit\"]","operationId":"CreatePromotionCodeRedemption","parameters":[{"$ref":"#/components/parameters/AcceptLanguageHeaderOptional"},{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePromotionCodeRedemptionRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionCodeRedemptionMultiStatusResponse"}}},"description":"CreatePromotionCodeRedemption 207 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":["PromotionCodeRedemptions"]}}},"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"}]}