https://api.nexscope.ai/amazonAds/adsApi/v1/query/advertiserAccountsRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/amazonAds/adsApi/v1/query/advertiserAccounts |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId | integer | required | An Amazon Ads connection owned by the authenticated Nexscope user. |
method | string | required | The upstream account query uses POST. |
body | string | optional | JSON string for the Amazon Ads query. Use {} for accessible accounts, or include advertiserAccountIdFilter, isGlobalAccountFilter, maxResults (10-100), and nextToken. |
contentType | string | optional | Use application/json. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"advertiserAccounts": [
{
"advertiserAccountId": "amzn1.ads-account.example",
"alternateIds": [
{
"countryCode": "US",
"profileId": "1234567890",
"region": "NA"
}
],
"businessDetails": [
{}
],
"displayName": "Example Advertiser",
"isGlobalAccount": false,
"status": {
"statusCode": "APPROVED",
"statusMessage": "Approved"
}
}
],
"nextToken": "example-next-token"
}Response fields
Amazon Ads QueryAdvertiserAccount 200 response; the Nexscope route returns the provider account payload.
| Name | Type | Required | Description |
|---|---|---|---|
advertiserAccounts | array | optional | Advertiser accounts on this page (0-100). An empty array means no matching accounts. Minimum items: 0 Maximum items: 100 |
advertiserAccounts[] | object | required | Advertiser accounts on this page (0-100). An empty array means no matching accounts. |
advertiserAccounts[].advertiserAccountId | string | required | Unique Amazon Ads advertiser account ID. |
advertiserAccounts[].alternateIds | array | optional | Marketplace identifiers associated with this account. Minimum items: 0 Maximum items: 30 |
advertiserAccounts[].alternateIds[] | object | required | Item in advertiserAccounts[] alternateIds. |
advertiserAccounts[].alternateIds[].countryCode | string | optional | Marketplace country code. |
advertiserAccounts[].alternateIds[].dspAdvertiserId | string | optional | Regional DSP advertiser ID. |
advertiserAccounts[].alternateIds[].entityId | string | optional | Marketplace entity ID. |
advertiserAccounts[].alternateIds[].profileId | string | optional | Marketplace profile ID. |
advertiserAccounts[].alternateIds[].region | string | optional | Amazon Ads region. Allowed: EU, FE, NA |
advertiserAccounts[].businessDetails | array | required | Business details for the advertiser account. Minimum items: 1 Maximum items: 1 |
advertiserAccounts[].businessDetails[] | object | required | Item in advertiserAccounts[] businessDetails. |
advertiserAccounts[].businessDetails[].address | object | optional | Business address, when returned; contains sensitive contact details. |
advertiserAccounts[].businessDetails[].addressToken | string | optional | Linked business address token; sensitive. |
advertiserAccounts[].businessDetails[].businessRegistrationNumber | string | optional | Business registration number; sensitive. |
advertiserAccounts[].businessDetails[].website | string | optional | Business website. |
advertiserAccounts[].currencyCode | string | optional | Account currency code. |
advertiserAccounts[].displayName | string | optional | Advertiser account display name. |
advertiserAccounts[].industryVertical | string | optional | Industry vertical. |
advertiserAccounts[].isGlobalAccount | boolean | optional | Whether this is a global advertiser account. |
advertiserAccounts[].isTestAccount | boolean | optional | Whether this is a test account. |
advertiserAccounts[].managerAccountId | string | optional | Linked manager account ID. |
advertiserAccounts[].sellingAccountLinkRequests | array | optional | Selling account link requests. Minimum items: 0 Maximum items: 1 |
advertiserAccounts[].sellingAccountLinkRequests[] | object | required | Item in advertiserAccounts[] sellingAccountLinkRequests. |
advertiserAccounts[].status | object | required | Current advertiser account status. |
advertiserAccounts[].status.statusCode | string | required | Current account state. Allowed: APPROVED, ARCHIVED, REGISTRATION_IN_PROGRESS, REJECTED |
advertiserAccounts[].status.statusMessage | string | required | Human-readable status message. |
advertiserAccounts[].timeZoneIana | string | optional | Account time zone in IANA format. |
nextToken | string | optional | Continuation token for the next page, when returned. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.