Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"Locale":{"enum":["ar_AE","cs_CZ","de_DE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_CO","es_ES","es_MX","es_US","fr_CA","fr_FR","he_IL","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN","zh_TW"],"type":"string"},"PartnerOpportunitiesApplicationMarketplace":{"description":"Plain text marketplace value.\n\nProvided in opportunity data.","enum":["AE","AU","BR","CA","DE","EG","ES","FR","GB","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","UK","US"],"type":"string"},"PartnerOpportunitiesApplicationStatus":{"properties":{"campaignId":{"type":"string"},"recommendationId":{"type":"string"},"status":{"enum":["FAILED","IN_PROGRESS","PUBLISHED","REJECTED","SUCCESS"],"type":"string"}},"required":["campaignId","recommendationId","status"],"type":"object"},"PartnerOpportunitiesApplicationStatusErrorDtoV1":{"properties":{"code":{"enum":["PO_APPLICATION_STATUS_BAD_REQUEST","PO_APPLICATION_STATUS_INTERNAL_SERVER_ERROR"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"PartnerOpportunitiesApplicationStatusRequestDtoV1":{"properties":{"advertiserType":{"description":"Entity Type\n\nProvided in opportunity data as 'advertiserType'.","enum":["SELLER","VENDOR"],"type":"string"},"encryptedAdvertiserId":{"description":"The encrypted advertiser ID.\n\nProvided in opportunity data.","type":"string"},"entityId":{"description":"Entity ID\n\nProvided in opportunity data.","type":"string"},"marketplace":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationMarketplace"},"recommendationIds":{"description":"A list of recommendation IDs for which status will be retrieved.\n\nProvided in opportunity data.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["advertiserType","encryptedAdvertiserId","entityId","marketplace","recommendationIds"],"type":"object"},"PartnerOpportunitiesApplicationStatusResponseDtoV1":{"properties":{"statuses":{"items":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatus","properties":{}},"maxItems":500,"minItems":1,"type":"array"}},"required":["statuses"],"type":"object"},"PartnerOpportunitiesApplyErrorDtoV1":{"properties":{"code":{"enum":["PO_APPLY_ALREADY_APPLIED","PO_APPLY_BAD_REQUEST","PO_APPLY_INTERNAL_SERVER_ERROR","PO_APPLY_IN_TERMINAL_STATUS","PO_APPLY_UNPROCESSABLE_ERROR"],"type":"string"},"failures":{"items":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorFailures","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"message":{"type":"string"},"successes":{"items":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorSuccesses","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"required":["code","failures","message","successes"],"type":"object"},"PartnerOpportunitiesApplyErrorFailures":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"recommendationId":{"type":"string"}},"required":["code","message","recommendationId"],"type":"object"},"PartnerOpportunitiesApplyErrorSuccesses":{"properties":{"recommendationId":{"type":"string"}},"required":["recommendationId"],"type":"object"},"PartnerOpportunitiesApplyRequestDtoV1":{"properties":{"advertiserType":{"description":"Entity Type\n\nProvided in opportunity data as 'advertiserType'.","enum":["SELLER","VENDOR"],"type":"string"},"encryptedAdvertiserId":{"description":"The encrypted advertiser ID.\n\nProvided in opportunity data.","type":"string"},"entityId":{"description":"Entity ID\n\nProvided in opportunity data.","type":"string"},"marketplace":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationMarketplace"},"recommendationIds":{"description":"A list of recommendation IDs to apply for the given opportunity.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["advertiserType","encryptedAdvertiserId","entityId","marketplace","recommendationIds"],"type":"object"},"PartnerOpportunitiesOpportunitiesPageV1":{"properties":{"firstToken":{"description":"Pagination token back to the first page/element.","type":"string"},"lastToken":{"description":"Pagination token to the last page.","type":"string"},"nextToken":{"description":"Pagination token to the next page.","type":"string"},"opportunities":{"description":"The list of partner opportunities.","items":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunityV1","properties":{}},"maxItems":100,"minItems":1,"type":"array"},"prevToken":{"description":"Pagination token back to the previous page.","type":"string"},"totalResults":{"description":"Total results contained in the list of opportunities.","type":"number"}},"required":["opportunities","totalResults"],"type":"object"},"PartnerOpportunitiesOpportunitiesSummaryV1":{"properties":{"availableAudiences":{"description":"All available opportunity audience values with the number of opportunities for each.","items":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunityAudienceFilterSummaryV1","properties":{}},"maxItems":3,"minItems":3,"type":"array"},"availableObjectiveTypes":{"description":"All available opportunity objective values with the number of opportunities for each.","items":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunityObjectiveTypeFilterSummaryV1","properties":{}},"maxItems":12,"minItems":12,"type":"array"},"availableProducts":{"description":"All available opportunity product values with the number of opportunities for each.","items":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunityProductFilterSummaryV1","properties":{}},"maxItems":10,"minItems":10,"type":"array"},"opportunitiesCount":{"description":"Total number of opportunities for the partner.","type":"number"},"opportunitiesWithDataCount":{"description":"Number of actionable opportunities with data for the partner.","type":"number"},"uniqueAdvertiserApproximateCount":{"description":"Approximate number of unique advertisers across all opportunities for the partner.","type":"number"}},"required":["availableAudiences","availableObjectiveTypes","availableProducts","opportunitiesCount","opportunitiesWithDataCount","uniqueAdvertiserApproximateCount"],"type":"object"},"PartnerOpportunitiesOpportunityAudienceFilterSummaryV1":{"properties":{"count":{"type":"number"},"value":{"enum":["PARTNER","PARTNER_MANAGED_ADVERTISERS","PARTNER_MANAGED_AD_BUSINESS"],"type":"string"}},"required":["count","value"],"type":"object"},"PartnerOpportunitiesOpportunityDataMetadataV1":{"properties":{"rowCount":{"description":"Number of rows present in the latest partner opportunity data file.","type":"number"},"updatedDate":{"description":"Date the opportunity data file was generated/updated, in ISO 8601 format.","format":"date-time","type":"string"}},"required":["rowCount","updatedDate"],"type":"object"},"PartnerOpportunitiesOpportunityObjectiveTypeFilterSummaryV1":{"properties":{"count":{"type":"number"},"value":{"enum":["ADVERTISER_INSIGHTS","AD_API_ENDPOINT_ADOPTION","AMAZON_ACCOUNT_TEAM_RECOMMENDATIONS","BENCHMARKING_INSIGHTS","CAMPAIGN_OPTIMIZATION","CATEGORY_INSIGHTS","CLICK_CREDITS","DEALS","MARKETPLACE_EXPANSION","NEW_TO_BRAND_INSIGHTS","PARTNER_GROWTH","PATH_TO_PURCHASE_INSIGHTS","READY_TO_LAUNCH_CAMPAIGNS","RETAIL_INSIGHTS","SHARE_OF_VOICE_INSIGHTS","UNLAUNCHED_ASINS"],"type":"string"}},"required":["count","value"],"type":"object"},"PartnerOpportunitiesOpportunityProductFilterSummaryV1":{"properties":{"count":{"type":"number"},"value":{"enum":["AMAZON_DSP","AMAZON_LIVE","CROSS_PRODUCT","POSTS","SPONSORED_BRANDS","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY","SPONSORED_DISPLAY_VIDEO","SPONSORED_PRODUCTS","SPONSORED_TV","STORES","VIDEO_ADS"],"type":"string"}},"required":["count","value"],"type":"object"},"PartnerOpportunitiesOpportunityV1":{"properties":{"audience":{"description":"The intended audience of the opportunity. For example, it might be targeted towards optimizing partner metrics or the metrics of advertisers that the partner manages.","enum":["PARTNER","PARTNER_MANAGED_ADVERTISERS","PARTNER_MANAGED_AD_BUSINESS"],"type":"string"},"callToAction":{"description":"An explanation of why it's recommended to take the actions detailed in the opportunity's data file.","type":"string"},"createdDate":{"description":"When the opportunity was created, in ISO 8601 format. This should never change.","format":"date-time","type":"string"},"dataMetadata":{"allOf":[{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunityDataMetadataV1","properties":{}}],"description":"Contains the most recent data file information for the opportunity.\n\nCan be used to track the availability of a partner opportunity data file:\n if dataMetadata.rowCount > 0."},"dataUrl":{"description":"The URL through which an opportunity's data file (in CSV format) can be downloaded.\n\nA simple GET request is all that is necessary, which will automatically redirect to a presigned, short-lived URL.\n\nURLs expire in 15 minutes.","type":"string"},"description":{"description":"A detailed description of the opportunity and how it is pertinent to partners. May provide a summary of the underlying data provided in the opportunity data file.","type":"string"},"objective":{"description":"The objective of the opportunity. For example, an objective might be to drive sales, raise brand awareness, etc.\n\nDeprecated.","enum":["AWARENESS","BRAND_ENGAGEMENT","RETENTION","SALES"],"type":"string"},"objectiveType":{"description":"The objective type of the opportunity. For example, an objective type might be around providing the unlaunched ASINs you can optimize or deals you can action on.","enum":["ADVERTISER_INSIGHTS","AD_API_ENDPOINT_ADOPTION","AMAZON_ACCOUNT_TEAM_RECOMMENDATIONS","BENCHMARKING_INSIGHTS","CAMPAIGN_OPTIMIZATION","CATEGORY_INSIGHTS","CLICK_CREDITS","DEALS","MARKETPLACE_EXPANSION","NEW_TO_BRAND_INSIGHTS","PARTNER_GROWTH","PATH_TO_PURCHASE_INSIGHTS","READY_TO_LAUNCH_CAMPAIGNS","RETAIL_INSIGHTS","SHARE_OF_VOICE_INSIGHTS","UNLAUNCHED_ASINS"],"type":"string"},"partnerOpportunityId":{"description":"The unique ID for the opportunity.","type":"string"},"product":{"description":"The Amazon Advertising product to which the opportunity corresponds, like Amazon DSP, Video Ads, etc.","enum":["AMAZON_DSP","AMAZON_LIVE","CROSS_PRODUCT","POSTS","SPONSORED_BRANDS","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY","SPONSORED_DISPLAY_VIDEO","SPONSORED_PRODUCTS","SPONSORED_TV","STORES","VIDEO_ADS"],"type":"string"},"title":{"description":"The title of the opportunity.","type":"string"},"updatedDate":{"description":"When the opportunity was last updated, in ISO 8601 format.","format":"date-time","type":"string"}},"required":["audience","callToAction","createdDate","dataMetadata","dataUrl","description","objectiveType","partnerOpportunityId","product","title","updatedDate"],"type":"object"}},"securitySchemes":{}},"info":{"title":"Partner Opportunities","version":"3.0"},"openapi":"3.0.1","paths":{"/partnerOpportunities":{"get":{"description":"Gets a list of opportunities specific to the partner making the request.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Advertising-API-Manager-Account\n\n**Paramet...","operationId":"partnerOpportunitiesListOpportunities","parameters":[{"description":"The maximum number of results to return in a single page.","example":"10","in":"query","name":"maxResults","required":false,"schema":{"default":"10","maximum":100,"minimum":1,"type":"number"}},{"description":"An obfuscated cursor value that indicates which 'page' of results should be returned next.","example":"asdf1234","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"The desired locale for opportunity data to be presented in. The `title`, `description`, and `callToAction` fields of the response items support localization.","example":"en_US","in":"query","name":"locale","required":false,"schema":{"$ref":"#/components/schemas/Locale"}},{"in":"query","name":"retrieveTranslationKeys","required":false,"schema":{"default":"false","type":"boolean"}},{"description":"Filter for opportunities using advertiserId. Each advertiserId must be fewer than 50 characters.","example":"A12345BCD6789E","in":"query","name":"advertiserId","required":false,"schema":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Filter for opportunities using profileId. Each profileId must be fewer than 50 characters.","example":"1234567890","in":"query","name":"profileId","required":false,"schema":{"items":{"type":"number"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Filter for opportunities with these audience values.\n* PARTNER_MANAGED_ADVERTISERS - Recommendation relates to advertisers the partner manages.\n* PARTNER_MANAGED_AD_BUSINESS - Recommendation relates to other partners the partner interacts with.\n* PARTNER - Recommendation relates to you, the partner.","example":"PARTNER","in":"query","name":"audience","required":false,"schema":{"items":{"enum":["PARTNER","PARTNER_MANAGED_ADVERTISERS","PARTNER_MANAGED_AD_BUSINESS"],"type":"string"},"maxItems":3,"minItems":1,"type":"array"}},{"description":"Filter for opportunities with these objectiveType values.\n* AD_API_ENDPOINT_ADOPTION - Recommendation relates to adopting a new API endpoint.","example":"DEALS","in":"query","name":"objectiveType","required":false,"schema":{"items":{"enum":["ADVERTISER_INSIGHTS","AD_API_ENDPOINT_ADOPTION","AMAZON_ACCOUNT_TEAM_RECOMMENDATIONS","BENCHMARKING_INSIGHTS","CAMPAIGN_OPTIMIZATION","CATEGORY_INSIGHTS","CLICK_CREDITS","DEALS","MARKETPLACE_EXPANSION","NEW_TO_BRAND_INSIGHTS","PARTNER_GROWTH","PATH_TO_PURCHASE_INSIGHTS","READY_TO_LAUNCH_CAMPAIGNS","RETAIL_INSIGHTS","SHARE_OF_VOICE_INSIGHTS","UNLAUNCHED_ASINS"],"type":"string"},"maxItems":16,"minItems":1,"type":"array"}},{"description":"Filter for opportunities with these product values.\n* AMAZON_DSP - Recommendation relates to the Amazon DSP.\n* AMAZON_LIVE - Recommendation relates to Amazon's Live Show and Tell program.","example":"SPONSORED_PRODUCTS","in":"query","name":"product","required":false,"schema":{"items":{"enum":["AMAZON_DSP","AMAZON_LIVE","CROSS_PRODUCT","POSTS","SPONSORED_BRANDS","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY","SPONSORED_DISPLAY_VIDEO","SPONSORED_PRODUCTS","SPONSORED_TV","STORES","VIDEO_ADS"],"type":"string"},"maxItems":12,"minItems":1,"type":"array"}},{"description":"The identifier of a client associated with a 'Login with Amazon' account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"'Partner Network Account ID' which is accessible from Partner Network under the ['User settings'](https://advertising.amazon.com/partner-network/settings) link in the upper right corner.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunitiesPageV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunitiesPageV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunitiesPageV1"}}},"description":"A list of opportunities successfully retrieved."}},"summary":"","tags":["Partner Opportunities"]}},"/partnerOpportunities/summary":{"get":{"description":"Gets aggregated information about all opportunities specific to the partner making the request. Supported since V1.1.","operationId":"partnerOpportunitiesSummarizeOpportunities","parameters":[{"description":"Filter for opportunities with these audience values.\n* PARTNER_MANAGED_ADVERTISERS - Recommendation relates to advertisers the partner manages.\n* PARTNER_MANAGED_AD_BUSINESS - Recommendation relates to other partners the partner interacts with.\n* PARTNER - Recommendation relates to you, the partner.","example":"PARTNER","in":"query","name":"audience","required":false,"schema":{"items":{"enum":["PARTNER","PARTNER_MANAGED_ADVERTISERS","PARTNER_MANAGED_AD_BUSINESS"],"type":"string"},"maxItems":3,"minItems":1,"type":"array"}},{"description":"Filter for opportunities with these objectiveType values.\n* AD_API_ENDPOINT_ADOPTION - Recommendation relates to adopting a new API endpoint.","example":"DEALS","in":"query","name":"objectiveType","required":false,"schema":{"items":{"enum":["ADVERTISER_INSIGHTS","AD_API_ENDPOINT_ADOPTION","AMAZON_ACCOUNT_TEAM_RECOMMENDATIONS","BENCHMARKING_INSIGHTS","CAMPAIGN_OPTIMIZATION","CATEGORY_INSIGHTS","CLICK_CREDITS","DEALS","MARKETPLACE_EXPANSION","NEW_TO_BRAND_INSIGHTS","PARTNER_GROWTH","PATH_TO_PURCHASE_INSIGHTS","READY_TO_LAUNCH_CAMPAIGNS","RETAIL_INSIGHTS","SHARE_OF_VOICE_INSIGHTS","UNLAUNCHED_ASINS"],"type":"string"},"maxItems":16,"minItems":1,"type":"array"}},{"description":"Filter for opportunities with these product values.\n* AMAZON_DSP - Recommendation relates to the Amazon DSP.\n* AMAZON_LIVE - Recommendation relates to Amazon's Live Show and Tell program.","example":"SPONSORED_PRODUCTS","in":"query","name":"product","required":false,"schema":{"items":{"enum":["AMAZON_DSP","AMAZON_LIVE","CROSS_PRODUCT","POSTS","SPONSORED_BRANDS","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY","SPONSORED_DISPLAY_VIDEO","SPONSORED_PRODUCTS","SPONSORED_TV","STORES","VIDEO_ADS"],"type":"string"},"maxItems":12,"minItems":1,"type":"array"}},{"description":"The identifier of a client associated with a 'Login with Amazon' account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"'Partner Network Account ID' which is accessible from Partner Network under the ['User settings'](https://advertising.amazon.com/partner-network/settings) link in the upper right corner.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunitiesSummaryV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunitiesSummaryV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesOpportunitiesSummaryV1"}}},"description":"Information about per-partner opportunity data."}},"summary":"","tags":["Partner Opportunities"]}},"/partnerOpportunities/{partnerOpportunityId}/applicationStatus":{"post":{"description":"Retrieves the current status of applied recommendations.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Advertising-API-Manager-Account\n\n**Parameter in**:\nheader...","operationId":"partnerOpportunitiesApplicationStatus","parameters":[{"in":"path","name":"partnerOpportunityId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a client associated with a 'Login with Amazon' account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"'Partner Network Account ID' which is accessible from Partner Network under the ['User settings'](https://advertising.amazon.com/partner-network/settings) link in the upper right corner.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusRequestDtoV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusRequestDtoV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusRequestDtoV1"}}},"required":true},"responses":{"200":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusResponseDtoV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusResponseDtoV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusResponseDtoV1"}}},"description":"Returns a JSON payload with a list of recommendations and their corresponding status."},"400":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusErrorDtoV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusErrorDtoV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusErrorDtoV1"}}},"description":"Bad request - check that all provided request data matches what is provided in your opportunity file and try again."},"401":{"description":"Unauthorized - please double check your authentication headers and be sure to follow our [getting started guide](https://advertising.amazon.com/API/docs/en-us/guides/recommendations/partner-opportunities/getting-started#authorization)"},"429":{"description":"Too many requests - Request was denied due to request throttling. Please try again later."},"500":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusErrorDtoV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusErrorDtoV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplicationStatusErrorDtoV1"}}},"description":"Internal Server Error - we have been notified of the error and are taking action to see the issue rectified. Please try again later."}},"summary":"","tags":["Partner Opportunities"]}},"/partnerOpportunities/{partnerOpportunityId}/apply":{"post":{"description":"Applies a given set of recommendations. Application may be asynchronous. Application status may be checked using the applicationStatus operation.","operationId":"partnerOpportunitiesApply","parameters":[{"in":"path","name":"partnerOpportunityId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a client associated with a 'Login with Amazon' account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"'Partner Network Account ID' which is accessible from Partner Network under the ['User settings'](https://advertising.amazon.com/partner-network/settings) link in the upper right corner.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyRequestDtoV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyRequestDtoV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyRequestDtoV1"}}},"required":true},"responses":{"202":{"description":"Returns a 202 to indicate that all recommendations were accepted and will be processed over time."},"400":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorDtoV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorDtoV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorDtoV1"}}},"description":"Bad request - check that all provided request data matches what is provided in your opportunity file and try again."},"401":{"description":"Unauthorized - please double check your authentication headers and be sure to follow our [getting started guide](https://advertising.amazon.com/API/docs/en-us/guides/recommendations/partner-opportunities/getting-started#authorization)"},"422":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorDtoV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorDtoV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorDtoV1"}}},"description":"Unprocessable Content - some or all of the provided recommendation IDs failed to apply. See the response body for more information."},"429":{"description":"Too many requests - Request was denied due to request throttling. Please try again later."},"500":{"content":{"application/vnd.partneropportunity.v1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorDtoV1"}},"application/vnd.partneropportunity.v1.1+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorDtoV1"}},"application/vnd.partneropportunity.v1.2+json":{"schema":{"$ref":"#/components/schemas/PartnerOpportunitiesApplyErrorDtoV1"}}},"description":"Internal Server Error - we have been notified of the error and are taking action to see the issue rectified. Please try again later."}},"summary":"","tags":["Partner Opportunities"]}},"/partnerOpportunities/{partnerOpportunityId}/file":{"get":{"description":"Gets a 307 - TEMPORARY_REDIRECT to an opportunity data file.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Advertising-API-Manager-Account\n\n**Parameter in**:\nhea...","operationId":"partnerOpportunitiesGetOpportunityFile","parameters":[{"description":"The opportunity ID for which the file URL is desired.","in":"path","name":"partnerOpportunityId","required":true,"schema":{"type":"string"}},{"description":"Specify the desired file format for the opportunity data. Default is CSV.","example":"CSV","in":"query","name":"fileFormat","required":false,"schema":{"default":"CSV","enum":["CSV","GZIP_JSON"],"type":"string"}},{"description":"The identifier of a client associated with a 'Login with Amazon' account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"'Partner Network Account ID' which is accessible from Partner Network under the ['User settings'](https://advertising.amazon.com/partner-network/settings) link in the upper right corner.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"This response will never occur. Redirects will always happen instead, but OpenAPI requires a 200 response spec."},"307":{"description":"Redirect URL provided in Location header."},"404":{"description":"Not Found - The requested partnerOpportunityId has no available data file or the file is empty."}},"summary":"","tags":["Partner Opportunities"]}}}}