Skip to main content
POST /api/v2/storefront/inventory-sources/{sourceId}/launch Mints a single-use signed URL that drops the caller into the upstream managed-source admin UI. Pass an optional deep-link path to land on a specific page.

​
Request

curl -X POST https://api.interchange.io/api/v2/storefront/inventory-sources/retail-gam/launch \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "path": "/products" }'

​
Parameters

FieldTypeRequiredNotes
sourceIdstring (path)YesStorefront-scoped inventory source ID
pathstringNoManaged-source-relative deep-link path (e.g. /products, max 2048). No schemes and no .. segments. Omit to land on the source home

​
Response

{
  "url": "https://retail-gam.esa.interchange.io/launch?token=eyJ..."
}
The url is single-use and short-lived — redirect immediately. Do not store or share it.

​
Errors

  • 400 VALIDATION_ERROR — path contains a scheme or .. segment.
  • 401 UNAUTHORIZED — missing or invalid API key.
  • 404 NOT_FOUND — no ad-server-backed source with this sourceId.
See Errors for the full error contract.

Inventory source tasks

All operations

Get status

Operational snapshot

Get ad-server connection

Connection state

Test connection

Probe upstream reachability