{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"CountryCodeFilter":{"description":"Filters entities by ISO 3166-1 alpha-2 country codes","properties":{"include":{"items":{"description":"ISO 3166-1 alpha-2 country code (e.g. US, GB).","pattern":"^[A-Z]{2}$","type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"required":["include"],"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"$ref":"#/components/schemas/ErrorMessage"}},"type":"object"},"ErrorCode":{"description":"Error code","type":"string"},"ErrorMessage":{"description":"Human readable response message","type":"string"},"IdentityListRetailersResponseContent":{"properties":{"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"retailers":{"items":{"$ref":"#/components/schemas/Retailer"},"maxItems":200,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"ListRetailersRequestContent":{"properties":{"countryCodeFilter":{"$ref":"#/components/schemas/CountryCodeFilter"},"maxResults":{"default":"10","description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","maximum":200,"minimum":1,"type":"integer"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"retailerIdFilter":{"$ref":"#/components/schemas/RetailerIdFilter"}},"type":"object"},"Retailer":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the Retailer (e.g. US, GB).","pattern":"^[A-Z]{2}$","type":"string"},"domain":{"description":"The domain of the Retailer.","type":"string"},"name":{"description":"The name of the Retailer.","type":"string"},"retailerId":{"description":"The identifier of the Retailer.","type":"string"},"status":{"description":"Status of the Retailer.","enum":["ACTIVE","INACTIVE","RETIRED"],"type":"string"}},"type":"object"},"RetailerIdFilter":{"description":"Filter entities by the list of RetailerIds","properties":{"include":{"items":{"description":"Retailer\u0027s ids to filter","type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"required":["include"],"type":"object"}},"securitySchemes":{}},"info":{"description":"This API allows advertisers to retrieve retailer details for use in Retail Ad Service campaign management APIs.","title":"Retailer Identity API for Retail Ad Service","version":"3.0"},"openapi":"3.0.1","paths":{"/ras/v1/retailers/list":{"post":{"description":"Returns an array of all active retailers.\n\n**Requires one of these permissions**:\n[]","operationId":"RASv1ListRetailers","parameters":[{"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRetailersRequestContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityListRetailersResponseContent"}}},"description":"ListRetailers 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ListRetailers Bad Request 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Content Too Large 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"InternalServerException 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Gateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ServiceUnavailableException 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Gateway Timeout 504 response"}},"summary":"Returns a list of Retailers.","tags":["Retailers"]}}}}