{"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":{"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":["AD","AE","AF","AG","AI","AU","BR","CA","DE","ES","FR","GB","IT","JP","KR","MX","US"],"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. |","enum":["BAD_REQUEST","FORBIDDEN","INTERNAL_ERROR","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"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"QuerySupplierTargetItemRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/SupplierTargetItemAdProductFilter"},"categoryFilter":{"$ref":"#/components/schemas/SupplierTargetItemCategoryFilter"},"countriesFilter":{"$ref":"#/components/schemas/SupplierTargetItemCountryCodeFilter"},"idFilter":{"$ref":"#/components/schemas/SupplierTargetItemIdFilter"},"maxResults":{"default":20,"format":"int32","maximum":500,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SupplierTargetItemNameFilter"},"nextToken":{"type":"string"},"sort":{"items":{"$ref":"#/components/schemas/SupplierTargetItemSortOption"},"maxItems":1,"minItems":0,"type":"array"},"supplierAdProductIdFilter":{"$ref":"#/components/schemas/SupplierTargetItemSupplierAdProductIdFilter"},"supplierProposalDestinationIdFilter":{"$ref":"#/components/schemas/SupplierTargetItemSupplierProposalDestinationIdFilter"},"supplierTargetTypeFilter":{"$ref":"#/components/schemas/SupplierTargetItemSupplierTargetTypeFilter"}},"required":["adProductFilter","supplierAdProductIdFilter","supplierTargetTypeFilter"],"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"},"SupplierTargetItem":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"category":{"description":"Categories for this targeting item.","items":{"type":"string"},"maxItems":49,"minItems":0,"type":"array"},"countries":{"description":"Countries where this targeting item is available.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":49,"minItems":0,"type":"array"},"description":{"description":"Description of the targeting item.","type":"string"},"id":{"description":"Unique identifier for the targeting item.","type":"string"},"name":{"description":"Name of the targeting item.","type":"string"},"supplierAdProductId":{"description":"The supplier ad product associated with this targeting item.","type":"string"},"supplierProposalDestinationId":{"description":"Supplier proposal destination identifier.","type":"string"},"supplierTargetType":{"$ref":"#/components/schemas/SupplierTargetType"}},"required":["id","name","supplierTargetType"],"type":"object"},"SupplierTargetItemAdProductFilter":{"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"},"SupplierTargetItemCategoryFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierTargetItemCountryCodeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierTargetItemIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierTargetItemNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SupplierTargetItemNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SupplierTargetItemNameFilterType":{"description":"**SupplierTargetItemNameFilterType Enum:**\n| SupplierTargetItemNameFilterType | Description |\n| --- | --- |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH"],"type":"string"},"SupplierTargetItemSortOption":{"properties":{"by":{"$ref":"#/components/schemas/SupplierTargetItemSortOptionsFields"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"required":["by"],"type":"object"},"SupplierTargetItemSortOptionsFields":{"description":"Specify which field to order by.\n| Field Name | Supported Ordering |\n| --- | --- |\n| name | ASCENDING,DESCENDING |","enum":["name"],"type":"string"},"SupplierTargetItemSuccessResponse":{"properties":{"nextToken":{"type":"string"},"supplierTargetItems":{"items":{"$ref":"#/components/schemas/SupplierTargetItem"},"maxItems":500,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"SupplierTargetItemSupplierAdProductIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierTargetItemSupplierProposalDestinationIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierTargetItemSupplierTargetTypeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/SupplierTargetType"},"maxItems":12,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierTargetType":{"enum":["APP","AUDIENCE","AUDIENCE_AGE","AUDIENCE_EDUCATION","AUDIENCE_GENDER","AUDIENCE_HOMEOWNERSHIP","AUDIENCE_HOUSEHOLD_COMPOSITION","AUDIENCE_HOUSEHOLD_INCOME","AUDIENCE_INTERESTS","AUDIENCE_IN_MARKET","AUDIENCE_MARITAL_STATUS","AUDIENCE_MOOD","AUDIENCE_SOCIOECONOMIC_GROUP","CONTENT_CATEGORY","CONTENT_GENRE","CONTENT_RATING","CONTENT_SENSITIVE_CATEGORY","DAYPART","DAYPART_DAY","DAYPART_TIME","DEVICE_OPERATING_SYSTEM","DEVICE_TYPE","LOCATION_CITY","LOCATION_COUNTRY","LOCATION_DESIGNATED_MARKET_AREA","LOCATION_METRO","LOCATION_POSTAL_CODE","LOCATION_REGION","POSITION_VIDEO"],"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":"SupplierTargetItems API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/query/supplierTargetItems":{"post":{"description":"Fetch supplier target items\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"QuerySupplierTargetItem","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySupplierTargetItemRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierTargetItemSuccessResponse"}}},"description":"QuerySupplierTargetItem 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":["SupplierTargetItems"]}}},"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"}]}