Scope3 Storefront Ad Server Catalog API
The Storefront Ad Server Catalog API from Scope3 — 11 operation(s) for storefront ad server catalog.
Operations 18
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
POST
/esa/{esaId}/products
Create a wholesale product on an ad server source · Create a product for an ad server source
#
Ask an LLM
“How do I add a new wholesale product to my ad server?”
“Can I create a product as a draft before activating it?”
Tell an agent
Create product {name} on ad server source {esa_id} with delivery type {delivery_type}.
Add a {status} product {name} to ad server {esa_id} using inventory {inventory}.
GET
/esa/{esaId}/products
List wholesale products on an ad server source · List products for an ad server source
#
Ask an LLM
“Which wholesale products are defined on my ad server source?”
“Can I see the product catalog of one connected ad server?”
Tell an agent
List wholesale products on ad server source {esa_id}.
Show every product defined on ad server {esa_id}.
POST
/esa/{esaId}/products:validate
Validate a product draft without saving it · Validate a product draft for an ad server source
#
Ask an LLM
“Can I check a product definition for errors before creating it on the ad server?”
“What blocking errors and warnings would a product draft trigger?”
Tell an agent
Validate product draft {name} against ad server source {esa_id} without saving.
Dry-check this product request for ad server {esa_id}: inventory {inventory}, formats {format_options}.
GET
/esa/{esaId}/products/{productId}
View one wholesale product on an ad server source · Get a product for an ad server source
#
Ask an LLM
“What's configured on a specific wholesale product in my ad server?”
“Can I fetch one product by id from an ad server source?”
Tell an agent
Show product {product_id} on ad server source {esa_id}.
Get the configuration of wholesale product {product_id} from {esa_id}.
PUT
/esa/{esaId}/products/{productId}
Replace a wholesale product's full definition · Update a product for an ad server source
#
Ask an LLM
“Does editing a product on the ad server require sending the complete definition?”
“How do I fully replace a wholesale product's settings?”
Tell an agent
Replace product {product_id} on {esa_id} with name {name}, delivery {delivery_type} and inventory {inventory}.
Overwrite the whole definition of product {product_id} on ad server {esa_id}.
PATCH
/esa/{esaId}/products/{productId}
Change only some fields of a wholesale product · Change only the named fields of a product for an ad server source
#
Ask an LLM
“Can I change just a product's name or status without resending everything?”
“What happens to fields I leave out of a partial product update?”
Tell an agent
Set the status of product {product_id} on {esa_id} to {status}.
Only rename product {product_id} on ad server {esa_id} to {name}, leaving other fields as they are.
DELETE
/esa/{esaId}/products/{productId}
Delete a wholesale product from an ad server source · Delete a product for an ad server source
#
Ask an LLM
“How do I remove a wholesale product from my ad server?”
“Can I delete a product I no longer sell?”
Tell an agent destructive · confirm first
Delete product {product_id} from ad server source {esa_id}.
Remove wholesale product {product_id} on {esa_id}.
GET
/esa/{esaId}/signals
List targeting signals on an ad server source · List signals for an ad server source
#
Ask an LLM
“Which named targeting definitions have I authored for an ad server source?”
“Can I see all signal mappings on one ad server?”
Tell an agent
List signals on ad server source {esa_id}.
Show the targeting signal mappings for {esa_id}.
POST
/esa/{esaId}/signals
Create a signal mapping on an ad server source · Create or dry-run a signal for an ad server source
#
Ask an LLM
“How do I map ad-server targeting to a new named signal?”
“Can I preview a new signal mapping without saving it?”
Tell an agent
Create signal {signal_id} named {name} of value type {value_type} on {esa_id} with config {adapter_config}.
Dry-run new signal {signal_id} ({name}, {value_type}) on {esa_id} with config {adapter_config}, dry_run {dry_run}.
GET
/esa/{esaId}/signals/adapter-capabilities
See what signal targeting an ad server supports · Get signal capabilities for an ad server source
#
Ask an LLM
“What targeting types can my ad server adapter use for signals?”
“What adapter config shape does a signal need on this ad server?”
Tell an agent
Show signal capabilities for ad server source {esa_id}.
Get the signal adapter config shape for {esa_id}.
GET
/esa/{esaId}/signals/candidates
Browse ad-server targeting that can back a signal · List ad-server targeting for signal authoring
#
Ask an LLM
“Which audience segments and key-values on my ad server could back a signal?”
“Can I search ad-server targeting keys by name while authoring a signal?”
Tell an agent
Browse signal candidates on {esa_id} matching {q}.
List {candidate_type} targeting candidates under parent {parent_id} on ad server {esa_id}.
GET
/esa/{esaId}/signals/{signalId}
View one signal mapping on an ad server source · Get a signal for an ad server source
#
Ask an LLM
“How is a specific signal mapped to targeting on my ad server?”
“Can I fetch a single signal definition by id from an ad server?”
Tell an agent
Show signal {signal_id} on ad server source {esa_id}.
Get the mapping for signal {signal_id} on {esa_id}.
PUT
/esa/{esaId}/signals/{signalId}
Replace a signal mapping on an ad server source · Replace or dry-run a signal for an ad server source
#
Ask an LLM
“Can I preview changes to an existing ad-server signal before saving them?”
“Does replacing a signal mapping need the full definition again?”
Tell an agent
Replace signal {signal_id} on {esa_id} with name {name}, value type {value_type} and config {adapter_config}.
Dry-run replacing signal {body_signal_id} on {esa_id} path {signal_id}: {name}, {value_type}, {adapter_config}, dry_run {dry_run}.
DELETE
/esa/{esaId}/signals/{signalId}
Delete a signal mapping from an ad server source · Delete a signal for an ad server source
#
Ask an LLM
“How do I remove a signal mapping from my ad server?”
“Can I delete a targeting signal I authored on an ad server source?”
Tell an agent destructive · confirm first
Delete signal {signal_id} from ad server source {esa_id}.
Remove the {signal_id} mapping on {esa_id}.
GET
/esa/{esaId}/inventory/capabilities
See what inventory selection an ad server supports · Get inventory capabilities for an ad server source
#
Ask an LLM
“Which inventory selector dimensions does my ad server adapter support?”
“Can my ad server discover publisher properties?”
Tell an agent
Show inventory capabilities for ad server source {esa_id}.
List the selector dimensions ad server {esa_id} supports.
GET
/esa/{esaId}/inventory/publisher-properties
List publisher sites and apps on an ad server · List publisher properties for an ad server source
#
Ask an LLM
“Which sites and apps does my ad server connection expose?”
“Can I filter publisher properties by domain?”
Tell an agent
List publisher properties on ad server source {esa_id}.
Show all sites and apps exposed by {esa_id}.
GET
/esa/{esaId}/inventory/selectors
Search ad units and placements on an ad server · Search inventory selectors for an ad server source
#
Ask an LLM
“How do I find the ad units that could back a new product?”
“Can I limit an inventory selector search to video or a certain environment?”
Tell an agent
Search {selector_type} on ad server {esa_id} for {q}.
Find {media_type} {selector_type} inventory on {esa_id}.
GET
/esa/{esaId}/creative-formats
List creative formats on an ad server source · List creative formats for an ad server source
#
Ask an LLM
“Which creative formats does my ad server support?”
“Can I filter ad server creative formats by asset type?”
Tell an agent
List creative formats on ad server source {esa_id}.
Show {asset_type} creative formats on {esa_id}.