Skip to main content
PUT
/
inventory-sources
/
{sourceId}
Update inventory source
curl --request PUT \
  --url https://api.interchange.io/api/v2/storefront/inventory-sources/{sourceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "sourceId": "<string>",
  "name": "<string>",
  "executionType": "<string>",
  "executionConfig": {},
  "status": "pending",
  "agentId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "type": "SALES",
  "endpointUrl": "<string>",
  "protocol": "MCP",
  "description": "<string>",
  "authenticationType": "API_KEY",
  "authConfigured": true,
  "oauth": {
    "authorizationUrl": "<string>",
    "agentId": "<string>",
    "agentName": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.interchange.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
sourceId
string
required

Inventory source ID

Minimum string length: 1

Body

application/json
​
name
string

Updated display name

Required string length: 1 - 255
​
executionType
enum<string>

Updated execution type

Available options:
agent
​
executionConfig
object

Updated execution configuration

​
status
enum<string>

Updated source status (pending → active, active → disabled)

Available options:
pending,
active,
disabled
​
description
string

Updated agent description

Maximum string length: 2000
​
endpointUrl
string<uri>

Updated agent endpoint URL

Maximum string length: 2048
​
protocol
enum<string>

Updated agent protocol

Available options:
MCP,
A2A
​
authenticationType
enum<string>

Updated agent authentication type

Available options:
API_KEY,
NO_AUTH,
JWT,
OAUTH
​
auth
object

Updated authentication credentials. Omit to keep existing credentials.

Response

Update inventory source

Inventory source response

​
sourceId
string
required

Unique identifier within the storefront

​
name
string
required

Display name

​
executionType
string
required

Execution type

​
executionConfig
object
required

Execution configuration

​
status
enum<string>
required

Source lifecycle status

Available options:
pending,
active,
disabled
​
agentId
string | null
required

Linked agent ID (when executionType is agent)

​
createdAt
string<date-time>
required

Creation timestamp (ISO 8601)

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
updatedAt
string<date-time>
required

Last update timestamp (ISO 8601)

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
type
enum<string> | null

Agent type

Available options:
SALES,
SIGNAL,
CREATIVE,
OUTCOME
​
endpointUrl
string | null

Agent endpoint URL

​
protocol
enum<string> | null

Agent protocol

Available options:
MCP,
A2A
​
description
string | null

Agent description

​
authenticationType
enum<string> | null

Agent authentication type

Available options:
API_KEY,
NO_AUTH,
JWT,
OAUTH
​
authConfigured
boolean

Whether the agent has authentication configured

​
oauth
object

OAuth authorization info (for OAUTH agents)