{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","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"}},"ManagerAccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Manager Account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"AdProduct":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","enum":["AMAZON_DSP"],"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"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CountryCode":{"enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NG","NL","NZ","PL","SA","SE","SG","TR","US","ZA"],"type":"string"},"DeliveryChannel":{"description":"Where a supply source shows its ads, and how that inventory is bought. For example, desktop web bought through real-time bidding, or in-app inventory bought through a direct deal.\n**DeliveryChannel Enum:**\n| DeliveryChannel | Description |\n| --- | --- |\n| `Web-RTB` | Desktop and mobile web ads bought through real-time bidding. Third-party exchange supply. |\n| `MobileApp-RTB` | In-app mobile ads bought through real-time bidding. Third-party exchange supply. |\n| `CTV-RTB` | Connected-TV ads bought through real-time bidding. Third-party exchange supply. |","enum":["CTV-RTB","MobileApp-RTB","Web-RTB"],"type":"string"},"DeviceType":{"description":"**DeviceType Enum:**\n| DeviceType | Description |\n| --- | --- |\n| `DESKTOP` | Desktop computers and laptops. |\n| `MOBILE` | Mobile phones and tablets. |\n| `CONNECTED_TV` | Connected TV devices. |\n| `CONNECTED_DEVICE` | Connected TV, smart speakers. Used for audio AdGroup type. |","enum":["CONNECTED_DEVICE","CONNECTED_TV","DESKTOP","MOBILE"],"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| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |","enum":["BAD_REQUEST","FIELD_VALUE_IS_INVALID","FIELD_VALUE_NOT_FOUND","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","RESOURCE_ID_NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"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"},"IntegrationType":{"description":"**IntegrationType Enum:**\n| IntegrationType | Description |\n| --- | --- |\n| `DIRECT` | Supplier is directly integrated with ADSP via OpenRTB. |\n| `BIDSWITCH` | Supplier routes inventory through BidSwitch as an intermediary. |","enum":["BIDSWITCH","DIRECT"],"type":"string"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InventoryType":{"description":"**InventoryType Enum:**\n| InventoryType | Description |\n| --- | --- |\n| `STANDARD_DISPLAY` |  |\n| `AMAZON_MOBILE_DISPLAY` |  |\n| `AAP_MOBILE_APP` |  |\n| `DISPLAY` |  |\n| `MOBILE_DISPLAY` | Display ads optimized for mobile devices. |\n| `VIDEO` |  |\n| `STREAMING_TV` |  |\n| `ONLINE_VIDEO` |  |\n| `AUDIO` | Audio ads that serve on streaming audio inventory. |\n| `PODCAST` | Podcast ads that serve on streaming podcast inventory. |\n| `AUDIO_AMAZON_DEAL` |  |\n| `STREAMING_TV_AMAZON_DEAL` |  |\n| `LIVE_EVENTS` | Real-time broadcast inventory (sports, concerts, award shows) with audience volatility and concentrated traffic patterns requiring specialized pacing algorithms and event-specific metadata handling.  |\n| `DIGITAL_OUT_OF_HOME` | Ad inventory that serves in physical locations at Amazon stores and billboards. |\n| `NATIVE` | Native ads that match the form and function of the content in which they appear. |\n| `ALEXA_DEVICES` | Ad inventory that serves on Alexa-enabled devices. |\n| `ALL` | Supports all ad formats. |","enum":["AAP_MOBILE_APP","ALEXA_DEVICES","ALL","AMAZON_MOBILE_DISPLAY","AUDIO","AUDIO_AMAZON_DEAL","DIGITAL_OUT_OF_HOME","DISPLAY","LIVE_EVENTS","MOBILE_DISPLAY","NATIVE","ONLINE_VIDEO","PODCAST","STANDARD_DISPLAY","STREAMING_TV","STREAMING_TV_AMAZON_DEAL","VIDEO"],"type":"string"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"QuerySupplierRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/SupplierAdProductFilter"},"integrationTypeFilter":{"$ref":"#/components/schemas/SupplierIntegrationTypeFilter"},"maxResults":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"openAuctionDeliveryChannelsFilter":{"$ref":"#/components/schemas/SupplierDeliveryChannelFilter"},"openAuctionDeviceTypesFilter":{"$ref":"#/components/schemas/SupplierDeviceTypeFilter"},"openAuctionInventoryTypesFilter":{"$ref":"#/components/schemas/SupplierInventoryTypeFilter"},"sort":{"items":{"$ref":"#/components/schemas/SupplierSortOption"},"maxItems":1,"minItems":0,"type":"array"},"stateFilter":{"$ref":"#/components/schemas/SupplierSupplierStateFilter"},"supplierIdFilter":{"$ref":"#/components/schemas/SupplierSupplierIdFilter"},"supplierNameFilter":{"$ref":"#/components/schemas/SupplierSupplierNameFilter"},"typeFilter":{"$ref":"#/components/schemas/SupplierSupplierTypeFilter"}},"required":["adProductFilter"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SortDirection":{"description":"**SortDirection Enum:**\n| SortDirection | Description |\n| --- | --- |\n| `ASCENDING` | Sort in ascending order |\n| `DESCENDING` | Sort in descending order |","enum":["ASCENDING","DESCENDING"],"type":"string"},"Supplier":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"canonicalId":{"description":"The identifier advertisers use to target this supplier.","type":"string"},"countries":{"description":"ISO 3166-1 alpha-2 country codes where supplier operates.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":49,"minItems":0,"type":"array"},"domain":{"description":"Corporate SCO domain in sellers.json supply chain object (e.g., pubmatic.com).","type":"string"},"integrationType":{"$ref":"#/components/schemas/IntegrationType"},"owner":{"description":"Parent owner company name of the Supplier. Defaults to brand name if unspecified.","type":"string"},"state":{"$ref":"#/components/schemas/SupplierState"},"supplierId":{"description":"The unique identifier of the supplier (Long serialized as String).","type":"string"},"supplierName":{"description":"Canonical display name of the Supplier. Normalized across systems.","type":"string"},"supportedDeliveryChannels":{"$ref":"#/components/schemas/SupplierSupportedDeliveryChannels"},"supportedDeviceTypes":{"$ref":"#/components/schemas/SupplierSupportedDeviceTypes"},"supportedInventoryTypes":{"$ref":"#/components/schemas/SupplierSupportedInventoryTypes"},"type":{"$ref":"#/components/schemas/SupplierType"}},"required":["adProduct","supplierId","supplierName"],"type":"object"},"SupplierAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierDeliveryChannelFilter":{"properties":{"include":{"description":"**OpenAuctionDeliveryChannels Enum:**\n| OpenAuctionDeliveryChannels | Description |\n| --- | --- |\n| `Web-RTB` | Desktop and mobile web ads bought through real-time bidding. Third-party exchange supply. |\n| `MobileApp-RTB` | In-app mobile ads bought through real-time bidding. Third-party exchange supply. |\n| `CTV-RTB` | Connected-TV ads bought through real-time bidding. Third-party exchange supply. |","items":{"$ref":"#/components/schemas/DeliveryChannel"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierDeviceTypeFilter":{"properties":{"include":{"description":"**OpenAuctionDeviceTypes Enum:**\n| OpenAuctionDeviceTypes | Description |\n| --- | --- |\n| `DESKTOP` | Desktop computers and laptops. |\n| `MOBILE` | Mobile phones and tablets. |\n| `CONNECTED_TV` | Connected TV devices. |\n| `CONNECTED_DEVICE` | Connected TV, smart speakers. Used for audio AdGroup type. |","items":{"$ref":"#/components/schemas/DeviceType"},"maxItems":4,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierIntegrationTypeFilter":{"properties":{"include":{"description":"**IntegrationType Enum:**\n| IntegrationType | Description |\n| --- | --- |\n| `DIRECT` | Supplier is directly integrated with ADSP via OpenRTB. |\n| `BIDSWITCH` | Supplier routes inventory through BidSwitch as an intermediary. |","items":{"$ref":"#/components/schemas/IntegrationType"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierInventoryTypeFilter":{"properties":{"include":{"description":"**OpenAuctionInventoryTypes Enum:**\n| OpenAuctionInventoryTypes | Description |\n| --- | --- |\n| `STANDARD_DISPLAY` |  |\n| `AMAZON_MOBILE_DISPLAY` |  |\n| `AAP_MOBILE_APP` |  |\n| `DISPLAY` |  |\n| `MOBILE_DISPLAY` | Display ads optimized for mobile devices. |\n| `VIDEO` |  |\n| `STREAMING_TV` |  |\n| `ONLINE_VIDEO` |  |\n| `AUDIO` | Audio ads that serve on streaming audio inventory. |\n| `PODCAST` | Podcast ads that serve on streaming podcast inventory. |\n| `AUDIO_AMAZON_DEAL` |  |\n| `STREAMING_TV_AMAZON_DEAL` |  |\n| `LIVE_EVENTS` | Real-time broadcast inventory (sports, concerts, award shows) with audience volatility and concentrated traffic patterns requiring specialized pacing algorithms and event-specific metadata handling.  |\n| `DIGITAL_OUT_OF_HOME` | Ad inventory that serves in physical locations at Amazon stores and billboards. |\n| `NATIVE` | Native ads that match the form and function of the content in which they appear. |\n| `ALEXA_DEVICES` | Ad inventory that serves on Alexa-enabled devices. |\n| `ALL` | Supports all ad formats. |","items":{"$ref":"#/components/schemas/InventoryType"},"maxItems":17,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierSortOption":{"properties":{"by":{"$ref":"#/components/schemas/SupplierSortOptionsFields"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"required":["by"],"type":"object"},"SupplierSortOptionsFields":{"description":"Specify which field to order by.\n| Field Name | Supported Ordering |\n| --- | --- |\n| supplierName | ASCENDING,DESCENDING |","enum":["supplierName"],"type":"string"},"SupplierState":{"description":"**SupplierState Enum:**\n| SupplierState | Description |\n| --- | --- |\n| `CREATED` | Supplier record created but not yet in testing. |\n| `TESTING` | Integration is in testing or onboarding phase. |\n| `ACTIVE` | Supplier is live and sending production traffic to ADSP. |\n| `INACTIVE` | Supplier integration has been disabled or deprecated. |","enum":["ACTIVE","CREATED","INACTIVE","TESTING"],"type":"string"},"SupplierSuccessResponse":{"properties":{"nextToken":{"type":"string"},"suppliers":{"items":{"$ref":"#/components/schemas/Supplier"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"SupplierSupplierIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierSupplierNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SupplierSupplierNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SupplierSupplierNameFilterType":{"description":"**SupplierSupplierNameFilterType Enum:**\n| SupplierSupplierNameFilterType | Description |\n| --- | --- |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH"],"type":"string"},"SupplierSupplierStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `CREATED` | Supplier record created but not yet in testing. |\n| `TESTING` | Integration is in testing or onboarding phase. |\n| `ACTIVE` | Supplier is live and sending production traffic to ADSP. |\n| `INACTIVE` | Supplier integration has been disabled or deprecated. |","items":{"$ref":"#/components/schemas/SupplierState"},"maxItems":4,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierSupplierTypeFilter":{"properties":{"include":{"description":"**Type Enum:**\n| Type | Description |\n| --- | --- |\n| `THIRD_PARTY_EXCHANGE` | Third-party exchange (3PX). External SSP or exchange such as Magnite, PubMatic, or Index Exchange. |\n| `AMAZON_OWNED_AND_OPERATED` | Amazon owned-and-operated supply (Amazon.com, IMDb, Twitch, Fire TV, etc.). |\n| `AMAZON_PUBLISHER_DIRECT` | Amazon Publisher Direct (APD). Third-party premium publisher supply that advertisers reach directly through Amazon Publisher Services publisher-direct integrations. |","items":{"$ref":"#/components/schemas/SupplierType"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierSupportedDeliveryChannels":{"description":"Which delivery channels a supplier can serve, grouped by how that inventory is bought. Each field covers one buying method, so a new method can be added later as its own field.","properties":{"openAuctionDeliveryChannels":{"description":"The delivery channels this supplier offers in the open auction. An EMPTY list means the supplier cannot be targeted in the open auction.","items":{"$ref":"#/components/schemas/DeliveryChannel"},"maxItems":3,"minItems":0,"type":"array"}},"type":"object"},"SupplierSupportedDeviceTypes":{"description":"Which classes of device a supplier can serve, grouped by how that inventory is bought.","properties":{"openAuctionDeviceTypes":{"description":"The classes of device this supplier reaches in the open auction. An EMPTY list means the supplier cannot be targeted in the open auction.","items":{"$ref":"#/components/schemas/DeviceType"},"maxItems":4,"minItems":0,"type":"array"}},"type":"object"},"SupplierSupportedInventoryTypes":{"description":"What kinds of inventory a supplier can serve, grouped by how that inventory is bought. Each field covers one buying method, so a new method can be added later as its own field.","properties":{"openAuctionInventoryTypes":{"description":"The kinds of inventory this supplier offers in the open auction. An EMPTY list means the supplier cannot be targeted in the open auction.","items":{"$ref":"#/components/schemas/InventoryType"},"maxItems":17,"minItems":0,"type":"array"}},"type":"object"},"SupplierType":{"description":"The three supply categories an advertiser sees on the line item page.\n**SupplierType Enum:**\n| SupplierType | Description |\n| --- | --- |\n| `THIRD_PARTY_EXCHANGE` | Third-party exchange (3PX). External SSP or exchange such as Magnite, PubMatic, or Index Exchange. |\n| `AMAZON_OWNED_AND_OPERATED` | Amazon owned-and-operated supply (Amazon.com, IMDb, Twitch, Fire TV, etc.). |\n| `AMAZON_PUBLISHER_DIRECT` | Amazon Publisher Direct (APD). Third-party premium publisher supply that advertisers reach directly through Amazon Publisher Services publisher-direct integrations. |","enum":["AMAZON_OWNED_AND_OPERATED","AMAZON_PUBLISHER_DIRECT","THIRD_PARTY_EXCHANGE"],"type":"string"},"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.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"Suppliers API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/query/suppliers":{"post":{"description":"Query suppliers. A supplier is a business entity that sends advertising inventory to Amazon DSP, either through direct publisher relationships or as an intermediary such as a supply-side platform (SSP). Use this API to search suppliers by ID or name, or to find the suppliers that can serve a given inventory type or delivery channel in the open auction.\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"QuerySupplier","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySupplierRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierSuccessResponse"}}},"description":"QuerySupplier 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":["Suppliers"]}}},"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"}]}