How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scope3 Storefront Ad Server Buyer Routing API

The Storefront Ad Server Buyer Routing API from Scope3 — 12 operation(s) for storefront ad server buyer routing.

Scope3 Storefront Ad Server Buyer Routing API is one of 51 APIs that Scope3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Storefront Ad Server Buyer Routing. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 12 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.interchange.io/api/v2/storefront.

14 operations 12 paths 27 schemas 1 DELETE5 GET1 PATCH4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://aiapi.scope3.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Scope3 Storefront Ad Server Buyer Routing API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — API key or access token

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 1 DELETE, 5 GET, 1 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Storefront Ad Server Buyer Routing 14
GET
/esa/{esaId}/sandbox-account
Get ad server source sandbox-account readiness
getEsaSandboxAccountStatus 1 param → 200400401404500
POST
/esa/{esaId}/sandbox-account/ensure
Ensure ad server source sandbox account exists
ensureEsaSandboxAccount 1 param → 200400401404500
GET
/esa/{esaId}/advertisers
List adapter advertisers
listEsaAdapterAdvertisers 3 params → 200400401404500503
GET
/esa/{esaId}/gam/advertisers
List cached GAM advertisers
listEsaGamAdvertisers 5 params → 200400401500
POST
/esa/{esaId}/gam/advertisers/ensure
Ensure a GAM advertiser exists
ensureEsaGamAdvertiser 1 param body → 200400401500
PUT
/esa/{esaId}/default-advertiser
Set default advertiser
setEsaDefaultAdvertiser 1 param body → 200400401500
PUT
/esa/{esaId}/gam/default-advertiser
Set default GAM advertiser
setEsaDefaultGamAdvertiser 1 param body → 200400401500
POST
/esa/{esaId}/gam-custom-targeting-keys/ensure
Ensure GAM custom-targeting keys exist
ensureEsaGamCustomTargetingKeys 1 param body → 200400401409500
PUT
/esa/{esaId}/axe-keys
Configure AXE custom-targeting key names
configureEsaAxeKeys 1 param body → 200400401409500
GET
/esa/{esaId}/buyer-advertiser-mappings
List buyer advertiser mappings
listEsaBuyerAdvertiserMappings 3 params → 200400401500
POST
/esa/{esaId}/buyer-advertiser-mappings
Create buyer advertiser mapping
createEsaBuyerAdvertiserMapping 1 param body → 201400401500
PATCH
/esa/{esaId}/buyer-advertiser-mappings/{mappingId}
Update buyer advertiser mapping
updateEsaBuyerAdvertiserMapping 2 params body → 200400401500
DELETE
/esa/{esaId}/buyer-advertiser-mappings/{mappingId}
Delete buyer advertiser mapping
deleteEsaBuyerAdvertiserMapping 2 params → 204400401500
GET
/esa/{esaId}/recent-buyers
List recent buyers
listEsaRecentBuyers 3 params → 200400401500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are EsaSandboxAccountSummary (11 properties), BuyerAdvertiserMapping (8 properties), AdapterAdvertiserList (7 properties), EsaEnsureSandboxAccountResponse (7 properties). Each schema is shown below with its type and property counts.

GamCustomTargetingKeyEntry
object
3 properties 3 required
AdapterAdvertiser
object
3 properties 3 required
EsaSandboxAccountSummary
object
Sandbox account row from the managed ad-server source tenant. Sandbox accounts route to the tenant-managed sandbox advertiser and do not carry a caller-selecte…
11 properties 11 required
EsaEnsureSandboxAccountResponse
object
Result of idempotently ensuring the ESA tenant-managed sandbox account.
7 properties 7 required
SetDefaultAdvertiserBody
object
1 property 1 required
EnsureGamCustomTargetingKeysBody
object
1 property 1 required
BuyerAdvertiserMappingBody
object
5 properties 2 required
AxeKeysSetupTask
object
6 properties 3 required
RecentBuyerList
object
1 property 1 required
ErrorResponse
object
Standard error response
2 properties 2 required
ConfigureAxeKeysBody
object
3 properties 3 required
RecentBuyer
object
7 properties 1 required
GamAdvertiser
object
4 properties 3 required
SetDefaultGamAdvertiserBody
object
1 property 1 required
EnsureGamAdvertiserResponse
object
3 properties 2 required
EnsureGamAdvertiserBody
object
2 properties 1 required
BuyerAdvertiserMappingPatchBody
object
4 properties
AdapterAdvertiserList
object
7 properties 7 required
BuyerAdvertiserMappingList
object
1 property 1 required
SetDefaultGamAdvertiserResponse
object
1 property 1 required
EsaSandboxAccountStatus
object
Readiness of the ESA tenant-managed sandbox advertiser account used for no-spend buyer tests.
6 properties 6 required
EnsureGamCustomTargetingKeysResponse
object
2 properties 2 required
SetDefaultAdvertiserResponse
object
1 property 1 required
BuyerAdvertiserMapping
object
8 properties 5 required
ConfigureAxeKeysResponse
object
1 property 1 required
ApiError
object
Structured error object
4 properties 2 required
GamAdvertiserPage
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scope3-storefront-ad-server-buyer-routing-api-openapi.yml Raw ↑

Other APIs Scope3 publishes across the network.

Scope3 AI Impact Measurement API
Scope3 Benchmarks API
Scope3 Creative API
Scope3 Data API
Scope3 Gpu API
Scope3 Impact API
Scope3 Measure API
Scope3 Model API
Scope3 Node API
Scope3 Reload API
Scope3 Saved Lists API
Scope3 Segment API
Where this information came from

This is an independent, third-party profile of Scope3 Storefront Ad Server Buyer Routing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.