Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AccessDeniedExceptionResponseContent":{"description":"User does not have sufficient access to perform this action.","properties":{"message":{"type":"string"}},"type":"object"},"AdsAccount":{"description":"Ads Account structure response consists of the GlobalAccountID\n(advertisingAccountId) and other account metadata.","properties":{"accountName":{"type":"string"},"adsAccountId":{"description":"This is the global advertising account Id from the client.","pattern":"^[A-Za-z0-9.-]+$","type":"string"},"status":{"$ref":"#/components/schemas/Status"}},"required":["adsAccountId"],"type":"object"},"AdsAccountWithMetaData":{"description":"Ads Account structure response consists of the GlobalAccountID\n(advertisingAccountId) and other account metadata.\n","properties":{"accountName":{"type":"string"},"adsAccountId":{"description":"This is the global advertising account Id from the client.","pattern":"^[A-Za-z0-9.-]+$","type":"string"},"alternateIds":{"items":{"$ref":"#/components/schemas/AlternateId","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"countryCodes":{"description":"Amazon Ads is available in many but not all countries where Amazon sells goods.\nFor vendors, Global accounts come stock with all countries where Amazon Ads is available.","items":{"description":"A Country Code refers to 2-digit (UPPER CASE) country code\n","properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"errors":{"$ref":"#/components/schemas/CountryCodeToErrorListMap"},"status":{"$ref":"#/components/schemas/Status"}},"required":["adsAccountId"],"type":"object"},"AdvertisingAccountNotFoundExceptionResponseContent":{"description":"Advertising Account not found.","properties":{"message":{"type":"string"}},"type":"object"},"AlternateId":{"description":"A construct that represents alternate Id an Ads Account could have, such profile Id","properties":{"countryCode":{"description":"The country code of the advertising account","type":"string"},"entityId":{"description":"The entity id of the advertising account","type":"string"},"profileId":{"description":"The Profile Id of the advertising account","type":"number"}},"type":"object"},"AmazonAuthor":{"description":"Represent an Amazon Author.","properties":{"email":{"description":"The email address of the KDP or Author Central account","type":"string"}},"type":"object"},"AmazonSeller":{"description":"Represent an Amazon Seller.","properties":{"sellerCentralAccount":{"description":"The merchant customer id of the seller central account","type":"string"}},"type":"object"},"AmazonVendor":{"description":"Represent an Amazon Vendor.","properties":{"vendorGroup":{"description":"The vendor group id of the vendor","type":"string"}},"type":"object"},"Association":{"description":"Association can represent an Amazon Vendor, Seller or business who does not sell on Amazon","properties":{"amazonAuthor":{"$ref":"#/components/schemas/AmazonAuthor"},"amazonSeller":{"$ref":"#/components/schemas/AmazonSeller"},"amazonVendor":{"$ref":"#/components/schemas/AmazonVendor"},"business":{"$ref":"#/components/schemas/Business"}},"type":"object"},"Business":{"description":"Represent a business who does not sell on Amazon.\nThese fields are containing information about the client's business and will be used for business verification.","properties":{"addressLine1":{"description":"Address line 1 of the business","type":"string"},"addressLine2":{"description":"Address line 2 of the business.","type":"string"},"city":{"description":"The city of the business.","type":"string"},"countryCode":{"description":"Country code of the business.","type":"string"},"name":{"description":"The name of the business.","type":"string"},"phone":{"description":"The phone number of the business.","type":"string"},"state":{"description":"The state of the business.","type":"string"},"websiteUrl":{"description":"The website url of the business.","type":"string"},"zipCode":{"description":"Zip code of the business.","type":"string"}},"type":"object"},"CountryCodeToErrorListMap":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Error","properties":{}},"type":"array"},"type":"object"},"CreateTermsTokenRequestContent":{"properties":{"termsType":{"$ref":"#/components/schemas/TermsType"}},"type":"object"},"CreateTermsTokenResponseContent":{"properties":{"termsToken":{"description":"A Terms Token refers to an UUID token used for terms and conditions acceptance","type":"string"},"termsUrl":{"description":"The link to advertising terms page where the advertiser can view and accept.","type":"string"}},"required":["termsToken","termsUrl"],"type":"object"},"Error":{"description":"Error structure is to describe the various errors consist of\nerror id, error code, and a readable error message","properties":{"errorCode":{"minLength":1,"type":"string"},"errorId":{"type":"number"},"errorMessage":{"minLength":1,"type":"string"}},"type":"object"},"GetAccountResponseContent":{"properties":{"adsAccount":{"$ref":"#/components/schemas/AdsAccountWithMetaData"}},"type":"object"},"GetTermsTokenResponseContent":{"properties":{"termsTokenStatus":{"$ref":"#/components/schemas/TermsTokenStatus"},"termsType":{"$ref":"#/components/schemas/TermsType"}},"required":["termsTokenStatus"],"type":"object"},"InternalServerExceptionResponseContent":{"description":"Unexpected error during processing of request.","properties":{"message":{"type":"string"}},"type":"object"},"InvalidInputExceptionResponseContent":{"description":"Request failed because invalid parameters were provided.\nEnsure that all required parameters are provided.\n","properties":{"message":{"type":"string"}},"type":"object"},"ListAdsAccountsRequestContent":{"properties":{"maxResults":{"default":"100","maximum":100,"minimum":1,"type":"number"},"nextToken":{"description":"The token is used to fetch the next page of results if they exist.","type":"string"}},"type":"object"},"ListAdsAccountsResponseContent":{"properties":{"adsAccounts":{"items":{"$ref":"#/components/schemas/AdsAccountWithMetaData","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"RateExceededExceptionResponseContent":{"description":"Maximum sending rate exceeded.","properties":{"message":{"type":"string"}},"type":"object"},"RegisterAdsAccountRequestContent":{"properties":{"accountName":{"description":"Account names are typically the name of the company or brand being advertised. We recommend that you avoid using personal details such as first name, last name, phone number, social security number, credit card or other personally identifiable information.","type":"string"},"associations":{"description":"Associations you would like to link to this advertising account, could be Amazon Vendor, Seller, or just a regular business","items":{"$ref":"#/components/schemas/Association"},"maxItems":1,"minItems":0,"type":"array"},"countryCodes":{"description":"The countries that you want this account to operate in.","items":{"description":"A Country Code refers to 2-digit (UPPER CASE) country code","type":"string"},"maxItems":1,"minItems":0,"type":"array"},"termsToken":{"description":"We recommend you do not provide this field since we can determine if the customer has accepted the terms for you. An obfuscated identifier of the termsToken, which is activated when an advertisers accepts the Amazon Ads Agreement in relation to the ads account being register.","type":"string"}},"type":"object"},"RegisterAdsAccountResponseContent":{"properties":{"adsAccount":{"$ref":"#/components/schemas/AdsAccount"}},"type":"object"},"Status":{"description":"The current state of the account. Statuses include Pending, Partially Created, Created, and Disabled.\nIf the account is in pending, it's registration is in progress and you'll need to call back again...","enum":["CREATED","DISABLED","PARTIALLY_CREATED","PENDING"],"type":"string"},"TermsTokenStatus":{"description":"The current state of the terms token.\nCreated is the initial state, that's after the integrator requests a token.\nAccepted is set once the customer has viewed the terms page and accepted it.\nRedeemed means when the token is used and cannot be used again.","enum":["ACCEPTED","CREATED","REDEEMED"],"type":"string"},"TermsType":{"description":"There are different Terms and Conditions for different amazon advertising platforms.\nThis enum will keep track of these different types of terms and is used in validating\nwhether or not a given user in an advertising account has accepted T&C or not.","enum":["ADVERTISING","MARKETING_CLOUD","PARTNER_NETWORK"],"type":"string"},"V2AccessDeniedExceptionResponseContent":{"description":"User does not have sufficient access to perform this action.","properties":{"errors":{"items":{"$ref":"#/components/schemas/Error","properties":{}},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"V2InternalInvalidInputExceptionResponseContent":{"description":"Request failed because invalid parameters were provided.\nEnsure that all required parameters are provided.","properties":{"errors":{"items":{"$ref":"#/components/schemas/Error","properties":{}},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"V2InternalServerExceptionResponseContent":{"description":"Unexpected error during processing of request.","properties":{"errors":{"items":{"$ref":"#/components/schemas/Error","properties":{}},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"V2InvalidInputExceptionResponseContent":{"description":"Request failed because invalid parameters were provided.\nEnsure that all required parameters are provided.\n","properties":{"errors":{"items":{"$ref":"#/components/schemas/Error","properties":{}},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"V2RateExceededExceptionResponseContent":{"description":"Maximum sending rate exceeded.","properties":{"errors":{"items":{"$ref":"#/components/schemas/Error","properties":{}},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"}},"securitySchemes":{}},"info":{"title":"Advertising Accounts","version":"3.0"},"openapi":"3.0.1","paths":{"/adsAccounts":{"post":{"description":"Create a new advertising account tied to a specific Amazon vendor, seller or author, or to a business who does not sell on Amazon.\n\n**Requires one of these permissions**:\n[]","operationId":"RegisterAdsAccount","parameters":[{"description":"The identifier of a client associated with a Login with Amazon account.","in":"header","name":"Amazon-Advertising-API-ClientId","schema":{"description":"The identifier of a client associated with a Login with Amazon account.","type":"string"}}],"requestBody":{"content":{"application/vnd.registeradsaccountresource.v1+json":{"schema":{"$ref":"#/components/schemas/RegisterAdsAccountRequestContent"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterAdsAccountResponseContent"}}},"description":"RegisterAdsAccount 201 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2InvalidInputExceptionResponseContent"}}},"description":"V2InvalidInputException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2AccessDeniedExceptionResponseContent"}}},"description":"V2AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2RateExceededExceptionResponseContent"}}},"description":"V2RateExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2InternalServerExceptionResponseContent"}}},"description":"V2InternalServerException 500 response"}},"summary":"Create a new advertising account tied to a specific Amazon vendor, seller or author, or to a business who does not sell on Amazon.","tags":["Account"]}},"/adsAccounts/list":{"post":{"description":"List all advertising accounts for the user associated with the access token.\n\n**Requires one of these permissions**:\n[]","operationId":"ListAdsAccounts","parameters":[{"description":"The identifier of a client associated with a Login with Amazon account.","in":"header","name":"Amazon-Advertising-API-ClientId","schema":{"description":"The identifier of a client associated with a Login with Amazon account.","type":"string"}}],"requestBody":{"content":{"application/vnd.listaccountsresource.v1+json":{"schema":{"$ref":"#/components/schemas/ListAdsAccountsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.listaccountsresource.v1+json":{"schema":{"$ref":"#/components/schemas/ListAdsAccountsResponseContent"}}},"description":"ListAdsAccounts 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2InvalidInputExceptionResponseContent"}}},"description":"V2InvalidInputException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2AccessDeniedExceptionResponseContent"}}},"description":"V2AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2RateExceededExceptionResponseContent"}}},"description":"V2RateExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2InternalServerExceptionResponseContent"}}},"description":"V2InternalServerException 500 response"}},"summary":"List all advertising accounts for the user associated with the access token.","tags":["Account"]}},"/adsAccounts/{advertisingAccountId}":{"get":{"description":"Request attributes of a given advertising account.\n\n**Requires one of these permissions**:\n[]","operationId":"GetAccount","parameters":[{"description":"This is the global advertising account Id from the client.","in":"path","name":"advertisingAccountId","required":true,"schema":{"description":"This is the global advertising account Id from the client.","pattern":"^[A-Za-z0-9.-]+$","type":"string"}},{"description":"The identifier of a client associated with a Login with Amazon account.","in":"header","name":"Amazon-Advertising-API-ClientId","schema":{"description":"The identifier of a client associated with a Login with Amazon account.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.accountresource.v1+json":{"schema":{"$ref":"#/components/schemas/GetAccountResponseContent"}}},"description":"GetAccount 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputExceptionResponseContent"}}},"description":"InvalidInputException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvertisingAccountNotFoundExceptionResponseContent"}}},"description":"AdvertisingAccountNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateExceededExceptionResponseContent"}}},"description":"RateExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"summary":"Request attributes of a given advertising account.","tags":["Account"]}},"/termsTokens":{"post":{"description":"Create a new UUID terms token for the customer to accept advertising terms\n\n**Requires one of these permissions**:\n[]","operationId":"CreateTermsToken","parameters":[{"description":"An identifier of API client making the request on behalf of the customer.","examples":{"CreateTermsToken_example1":{"summary":"Request with a valid input.","value":"amzn1.application-oa2-client.647610038d6d4f3d868b6207ec6ef9ca"}},"in":"header","name":"Amazon-Advertising-API-ClientId","schema":{"description":"An identifier of API client making the request on behalf of the customer.","pattern":"^[A-Za-z0-9.-]+$","type":"string"}}],"requestBody":{"content":{"application/vnd.GlobalRegistrationService.TermsTokenResource.v1.0+json":{"schema":{"$ref":"#/components/schemas/CreateTermsTokenRequestContent"}}}},"responses":{"201":{"content":{"application/vnd.termstokenresource.v1+json":{"schema":{"$ref":"#/components/schemas/CreateTermsTokenResponseContent"}}},"description":"CreateTermsToken 201 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2InvalidInputExceptionResponseContent"}}},"description":"V2InvalidInputException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2AccessDeniedExceptionResponseContent"}}},"description":"V2AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2RateExceededExceptionResponseContent"}}},"description":"V2RateExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2InternalServerExceptionResponseContent"}}},"description":"V2InternalServerException 500 response"}},"summary":"Create a new UUID terms token for the customer to accept advertising terms","tags":["Terms Token"]}},"/termsTokens/{termsToken}":{"get":{"description":"Get the terms token status for the customer\n\n**Requires one of these permissions**:\n[]","operationId":"GetTermsToken","parameters":[{"description":"A Terms Token refers to an UUID token used for terms and conditions acceptance\n","examples":{"GetTermsToken_example1":{"summary":"Request with a valid input.","value":"481cea33-463b-4cbe-9593-762ea68306ad"}},"in":"path","name":"termsToken","required":true,"schema":{"description":"A Terms Token refers to an UUID token used for terms and conditions acceptance","type":"string"}},{"description":"The identifier of a client associated with a Login with Amazon account.","examples":{"GetTermsToken_example1":{"summary":"Request with a valid input.","value":"amzn1.application-oa2-client.ee9a9686317b4ef594d2cacbb41d30ea"}},"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"}}],"responses":{"200":{"content":{"application/vnd.termstokenresource.v1+json":{"schema":{"$ref":"#/components/schemas/GetTermsTokenResponseContent"}}},"description":"GetTermsToken 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2InternalInvalidInputExceptionResponseContent"}}},"description":"V2InternalInvalidInputException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2AccessDeniedExceptionResponseContent"}}},"description":"V2AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2RateExceededExceptionResponseContent"}}},"description":"V2RateExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2InternalServerExceptionResponseContent"}}},"description":"V2InternalServerException 500 response"}},"summary":"Get the terms token status for the customer","tags":["Terms Token"]}}}}