{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"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":{"AccountCombinationInvitation":{"properties":{"accountCombinationInvitationId":{"description":"The unique identifier for the account combination invitation.","type":"string"},"accountsToCombine":{"description":"The list of accounts to combine into one Advertiser Account.","items":{"$ref":"#/components/schemas/AccountToCombine"},"maxItems":17,"minItems":1,"type":"array"},"advertiserAccountId":{"description":"The identifier of the Advertiser Account in the account combination invitation, in ACI format. Example: amzn1.ads-account.g.a1bc2de3fg4hi5jk6lm7no8pq.","type":"string"},"status":{"$ref":"#/components/schemas/AccountCombinationInvitationStatus"},"statusMessage":{"description":"Additional information about the current status, including error details, rejection info and recommended actions.","type":"string"}},"required":["accountCombinationInvitationId","accountsToCombine","statusMessage"],"type":"object"},"AccountCombinationInvitationAccountCombinationInvitationIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AccountCombinationInvitationCreate":{"properties":{"accountsToCombine":{"description":"The list of accounts to combine into one Advertiser Account.","items":{"$ref":"#/components/schemas/CreateAccountToCombine"},"maxItems":17,"minItems":1,"type":"array"},"advertiserAccountId":{"description":"The identifier of the Advertiser Account in the account combination invitation, in ACI format. Example: amzn1.ads-account.g.a1bc2de3fg4hi5jk6lm7no8pq.","type":"string"},"status":{"$ref":"#/components/schemas/AccountCombinationInvitationStatus"}},"required":["accountsToCombine"],"type":"object"},"AccountCombinationInvitationMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":50,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AccountCombinationInvitationMultiStatusSuccess"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"AccountCombinationInvitationMultiStatusSuccess":{"properties":{"accountCombinationInvitation":{"$ref":"#/components/schemas/AccountCombinationInvitation"},"index":{"format":"int32","maximum":49,"minimum":0,"type":"integer"}},"required":["accountCombinationInvitation","index"],"type":"object"},"AccountCombinationInvitationStatus":{"description":"This represents the current state of an account combination invitation.\n**AccountCombinationInvitationStatus Enum:**\n\n| AccountCombinationInvitationStatus | Description |\n|------|------|\n| `APPROVED` | The combination invitation has been approved by an admin. |\n| `PENDING` | The combination invitation is pending approval. |\n| `REJECTED` | The combination invitation was rejected by an admin. |\n| `RESENT` | The combination invitation has been re-sent after a previous attempt. |\n","enum":["APPROVED","PENDING","REJECTED","RESENT"],"type":"string"},"AccountCombinationInvitationSuccessResponse":{"properties":{"accountCombinationInvitations":{"items":{"$ref":"#/components/schemas/AccountCombinationInvitation"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AccountCombinationInvitationUpdate":{"properties":{"accountCombinationInvitationId":{"description":"The unique identifier for the account combination invitation.","type":"string"},"accountsToCombine":{"description":"The list of accounts to combine into one Advertiser Account.","items":{"$ref":"#/components/schemas/CreateAccountToCombine"},"maxItems":17,"minItems":1,"type":"array"},"advertiserAccountId":{"description":"The identifier of the Advertiser Account in the account combination invitation, in ACI format. Example: amzn1.ads-account.g.a1bc2de3fg4hi5jk6lm7no8pq.","type":"string"},"status":{"$ref":"#/components/schemas/AccountCombinationInvitationStatus"}},"required":["accountCombinationInvitationId"],"type":"object"},"AccountFunction":{"description":"All available options on how to combine an account metadata with other accounts.\n**AccountFunction Enum:**\n\n| AccountFunction | Description |\n|------|------|\n| `BILLING_PREFERENCES_SOURCE` | Inherit billing preferences from this advertising account. |\n| `BUSINESS_DETAILS_SOURCE` | Inherit business details from this DSP advertising account: business address, currency, industry, time zone. |\n","enum":["BILLING_PREFERENCES_SOURCE","BUSINESS_DETAILS_SOURCE"],"type":"string"},"AccountId":{"description":"| AccountId | Description |\n|------|------|\n| `advertiserAccountId` | This represents an advertiser account. It can be a global advertiser account that works across countries (ex: amzn1.ads-account.g.a1bc2de3fg4hi5jk6lm7no8pq) or a DSP-only advertiser account (ex: 123456789012345678 or amzn1.ads1.aa1.gb.ENTITY108A02T7KWJGM). |\n","oneOf":[{"properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"],"title":"advertiserAccountId","type":"object"}]},"AccountToCombine":{"description":"Represents the account-to-be-combined and its attributes.","properties":{"accountFunctions":{"description":"Defines the different ways this account will be used to combine metadata with other accounts.","items":{"$ref":"#/components/schemas/AccountFunction"},"maxItems":5,"minItems":0,"type":"array"},"accountId":{"$ref":"#/components/schemas/AccountId"}},"required":["accountId"],"type":"object"},"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"},"CreateAccountCombinationInvitationRequest":{"properties":{"accountCombinationInvitations":{"items":{"$ref":"#/components/schemas/AccountCombinationInvitationCreate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["accountCombinationInvitations"],"type":"object"},"CreateAccountToCombine":{"description":"Represents the account-to-be-combined and its attributes.","properties":{"accountFunctions":{"description":"Defines the different ways this account will be used to combine metadata with other accounts.","items":{"$ref":"#/components/schemas/AccountFunction"},"maxItems":5,"minItems":0,"type":"array"},"accountId":{"$ref":"#/components/schemas/AccountId"}},"required":["accountId"],"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n\n| ErrorCode | Description |\n|------|------|\n| `ACCESS_DENIED_FOR_MANAGER_ACCOUNT` | The request does not have access to the manager account provided in the registration request. |\n| `ACCOUNT_ALREADY_EXISTS_FOR_ACCOUNT_NAME` | An advertiser account already exists with this display name. |\n| `ACCOUNT_ALREADY_EXISTS_FOR_SELLING_ACCOUNT` | An advertiser account already exists for this selling account. |\n| `ACCOUNT_ALREADY_EXISTS_FOR_VENDOR` | An advertiser account already exists for the selected vendor. |\n| `ADDRESS_BUSINESS_NAME_TOO_LONG` | Business name provided is too long. |\n| `ADDRESS_INVALID_STATE` | The state provided in business address is invalid. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `INVALID_INPUT` | The request has invalid input parameters. |\n| `INVALID_STATE_OR_REGION` | The state provided in business address is invalid. |\n| `INVALID_WEBSITE_URL` | The website url provided in business detail is invalid |\n| `INVALID_ZIP_CODE` | The zip code provided in business address is invalid. |\n| `MISSING_ADDRESS_LINE_ONE` | Address line 1 is missing in business address. |\n| `MISSING_BUSINESS_NAME` | Business name is missing from business detail. |\n| `MISSING_CITY` | City is missing in business address. |\n| `MISSING_COUNTRY_CODE` | Country is missing in business address. |\n| `MISSING_PHONE_NUMBER` | Phone number is missing from business detail. |\n| `MISSING_STATE` | State is missing in business address. |\n| `MISSING_WEBSITE_URL` | Website url is missing from business detail. |\n| `MISSING_ZIP_CODE` | Zip code is missing in business address. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n","enum":["ACCESS_DENIED_FOR_MANAGER_ACCOUNT","ACCOUNT_ALREADY_EXISTS_FOR_ACCOUNT_NAME","ACCOUNT_ALREADY_EXISTS_FOR_SELLING_ACCOUNT","ACCOUNT_ALREADY_EXISTS_FOR_VENDOR","ADDRESS_BUSINESS_NAME_TOO_LONG","ADDRESS_INVALID_STATE","BAD_REQUEST","CONTENT_TOO_LARGE","FORBIDDEN","INTERNAL_ERROR","INVALID_INPUT","INVALID_STATE_OR_REGION","INVALID_WEBSITE_URL","INVALID_ZIP_CODE","MISSING_ADDRESS_LINE_ONE","MISSING_BUSINESS_NAME","MISSING_CITY","MISSING_COUNTRY_CODE","MISSING_PHONE_NUMBER","MISSING_STATE","MISSING_WEBSITE_URL","MISSING_ZIP_CODE","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"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"},"QueryAccountCombinationInvitationRequest":{"properties":{"accountCombinationInvitationIdFilter":{"$ref":"#/components/schemas/AccountCombinationInvitationAccountCombinationInvitationIdFilter"},"maxResults":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"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"},"UpdateAccountCombinationInvitationRequest":{"properties":{"accountCombinationInvitations":{"items":{"$ref":"#/components/schemas/AccountCombinationInvitationUpdate"},"maxItems":50,"minItems":1,"type":"array"}},"required":["accountCombinationInvitations"],"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_ALL.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p_ALL.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p_ALL.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p_ALL.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p_ALL.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p_ALL.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p_ALL.json))","title":"AccountCombinationInvitations API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/accountCombinationInvitations":{"post":{"description":"Create an invitation to combine Advertising Accounts under a Single Global Account. Currently supports combining a Global SA account with one or more DSP Accounts\n\n**Requires one of these permissions**:\n[]","operationId":"CreateAccountCombinationInvitation","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountCombinationInvitationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCombinationInvitationMultiStatusResponse"}}},"description":"CreateAccountCombinationInvitation 207 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":["AccountCombinationInvitations"]}},"/adsApi/v1/query/accountCombinationInvitations":{"post":{"description":"Query invitations to combine advertising accounts under a Single Global Account. This API allows the user to query any invitations open for a given ads account. \n\n**Requires one of these permissions**:\n[]","operationId":"QueryAccountCombinationInvitation","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAccountCombinationInvitationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCombinationInvitationSuccessResponse"}}},"description":"QueryAccountCombinationInvitation 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":["AccountCombinationInvitations"]}},"/adsApi/v1/update/accountCombinationInvitations":{"post":{"description":"Update an invitation to combine Advertising Accounts under a Single Global Account. This API supports updating the invitations to approve, reject, or resend them.\n\n**Requires one of these permissions**:\n[]","operationId":"UpdateAccountCombinationInvitation","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountCombinationInvitationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCombinationInvitationMultiStatusResponse"}}},"description":"UpdateAccountCombinationInvitation 207 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":["AccountCombinationInvitations"]}}},"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"}]}