Skip to main content
GET /api/v2/storefront/inventory-sources/{sourceId} Returns one inventory source with its full state, including the managedSa block for ad-server-backed sources and the linkedStorefront block for linked storefronts.

​
Request

curl https://api.interchange.io/api/v2/storefront/inventory-sources/retail-network-agent \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

FieldTypeRequiredNotes
sourceIdstring (path)YesStorefront-scoped inventory source ID

​
Response

{
  "id": "900123456789",
  "sourceId": "retail-network-agent",
  "name": "Retail Network Agent",
  "executionType": "AGENT",
  "status": "ACTIVE",
  "agentId": "agent_01HX...",
  "type": "SALES",
  "endpointUrl": "https://agent.retail-network.example.com/mcp",
  "protocol": "MCP",
  "authenticationType": "API_KEY",
  "authConfigured": true,
  "reportingType": "WEBHOOK",
  "isAdapterSource": false,
  "createdAt": "2026-04-25T12:05:00Z",
  "updatedAt": "2026-04-25T12:05:00Z"
}
For a MANAGED_SALES_AGENT source the response carries a managedSa object (connectionId, provisioningStatus, tenantId, adServer, lastError, timestamps). For a LINKED_STOREFRONT source it carries a linkedStorefront object. reportingType (WEBHOOK, BUCKET, POLLING) and reportingPollingCadence (DAILY, MONTHLY) are null for non-AGENT sources.

​
Errors

  • 401 UNAUTHORIZED — missing or invalid API key.
  • 404 NOT_FOUND — no source with this sourceId on your storefront.
See Errors for the full error contract.

Inventory source tasks

All operations

Inventory sources overview

Concepts and lifecycle

Update inventory source

Change fields or rotate auth

Get ad-server connection

Managed-source connection state