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 Catalog API

The Storefront Ad Server Catalog API from Scope3 — 11 operation(s) for storefront ad server catalog.

Scope3 Storefront Ad Server Catalog 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 Catalog. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 18 operations across 11 paths, and defines 11 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.

18 operations 11 paths 11 schemas 2 DELETE10 GET1 PATCH3 POST2 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 Catalog API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — API key or access token

Paths & Operations 18

Across 11 paths, the API surfaces 18 operations — 2 DELETE, 10 GET, 1 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Storefront Ad Server Catalog 18
POST
/esa/{esaId}/products
Create a product for an ad server source
createEsaProduct 1 param body → 201400401404500
GET
/esa/{esaId}/products
List products for an ad server source
listEsaProducts 1 param → 200400401404500
POST
/esa/{esaId}/products:validate
Validate a product draft for an ad server source
validateEsaProduct 1 param body → 200400401404500
GET
/esa/{esaId}/products/{productId}
Get a product for an ad server source
getEsaProduct 2 params → 200400401404500
PUT
/esa/{esaId}/products/{productId}
Update a product for an ad server source
updateEsaProduct 2 params body → 200400401404500
PATCH
/esa/{esaId}/products/{productId}
Change only the named fields of a product for an ad server source
patchEsaProduct 2 params body → 200400401404500
DELETE
/esa/{esaId}/products/{productId}
Delete a product for an ad server source
deleteEsaProduct 2 params → 204400401404500
GET
/esa/{esaId}/signals
List signals for an ad server source
listEsaSignals 1 param → 200400401404500
POST
/esa/{esaId}/signals
Create or dry-run a signal for an ad server source
createEsaSignal 2 params body → 200201400401500
GET
/esa/{esaId}/signals/adapter-capabilities
Get signal capabilities for an ad server source
getEsaSignalAdapterCapabilities 1 param → 200400401404500
GET
/esa/{esaId}/signals/candidates
List ad-server targeting for signal authoring
listEsaSignalCandidates 6 params → 200400401404500
GET
/esa/{esaId}/signals/{signalId}
Get a signal for an ad server source
getEsaSignal 2 params → 200400401404500
PUT
/esa/{esaId}/signals/{signalId}
Replace or dry-run a signal for an ad server source
updateEsaSignal 3 params body → 200400401500
DELETE
/esa/{esaId}/signals/{signalId}
Delete a signal for an ad server source
deleteEsaSignal 2 params → 204400401500
GET
/esa/{esaId}/inventory/capabilities
Get inventory capabilities for an ad server source
getEsaInventoryAdapterCapabilities 1 param → 200400401404500
GET
/esa/{esaId}/inventory/publisher-properties
List publisher properties for an ad server source
listEsaPublisherProperties 1 param → 200400401404500
GET
/esa/{esaId}/inventory/selectors
Search inventory selectors for an ad server source
searchEsaAdServerSelectors 8 params → 200400401404500
GET
/esa/{esaId}/creative-formats
List creative formats for an ad server source
listEsaCreativeFormats 3 params → 200400401404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EsaProductUpdateBody (7 properties), EsaProductPatchBody (7 properties), EsaAllowedPublisherSelector (5 properties), ApiError (4 properties). Each schema is shown below with its type and property counts.

EsaSignalResponse
object
EsaProductUpdateBody
object
Full salesagent WholesaleProductRequest update body for an ad-server source product. The upstream endpoint requires a complete replacement body; unknown/extra…
7 properties
VendorPricingOption
AdCP vendor pricing option. A signal carries zero or more; absence means the signal is free. Forwarded verbatim to the managed ad-server source.
EsaSignalListEnvelope
object
1 property 1 required
EsaCanonicalProductFormatOption
object
URL-free AdCP 3.1 product format declaration. Canonical formats use formatkind plus params and never agenturl; publisher-backed options pair formatoptionid wit…
4 properties 2 required
ErrorResponse
object
Standard error response
2 properties 2 required
EsaAllowedPublisherSelector
object
5 properties 3 required
EsaProductListEnvelope
object
1 property 1 required
ApiError
object
Structured error object
4 properties 2 required
EsaProductPatchBody
object
Partial change body for an ad-server-source product. Only the fields present are applied; an omitted field — or one sent as null — keeps its stored value, and…
7 properties
EsaPublisherPropertyListEnvelope
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scope3-storefront-ad-server-catalog-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 Catalog 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.