Create feed-backed modular source
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/inventory-sources/modular/feed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'{
"inventorySourceId": "<string>",
"sourceId": "<string>",
"projection": {
"inventorySource": {
"id": "<string>",
"storefrontId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"executionType": "MODULAR_SOURCE",
"status": "<string>",
"healthStatus": "<string>",
"lastError": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"modules": [
{
"moduleRowId": "<string>",
"inventorySourceId": "<string>",
"moduleInstanceId": "<string>",
"name": "<string>",
"provider": "<string>",
"contractId": "<string>",
"contractVersion": "<string>",
"contract": {
"contractId": "<string>",
"version": "<string>",
"moduleType": "<string>",
"displayName": "<string>",
"description": "<string>",
"constraints": [
"<string>"
],
"provider": "<string>"
},
"configuredFieldKeys": [
"<string>"
],
"missingSetupFieldsBySource": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"requiredFor": [],
"mapsTo": "<string>",
"enumValues": [
"<string>"
]
}
]
}
],
"lifecycle": [
{
"description": "<string>",
"outputKeys": [
"<string>"
],
"requiredFieldsBySource": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"requiredFor": [],
"mapsTo": "<string>",
"enumValues": [
"<string>"
]
}
]
}
],
"missingSetupFieldsBySource": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"requiredFor": [],
"mapsTo": "<string>",
"enumValues": [
"<string>"
]
}
]
}
],
"moduleConfigReady": true,
"workItemKind": "<string>",
"taskContract": {
"taskId": "<string>",
"requiredInputKeys": [
"<string>"
],
"requiredResultKeys": [
"<string>"
],
"outputKeys": [
"<string>"
],
"retryable": true,
"blocksStage": true,
"workItemKind": "<string>",
"fallbackWorkItemKind": "<string>",
"operatorAction": "<string>",
"idempotencyKeyFields": [
"<string>"
]
}
}
],
"openWorkItemCount": 4503599627370495,
"openWorkItemCountsByKind": {},
"lastError": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"issues": [
"<string>"
]
}
],
"lifecycleSummary": [
{
"supported": true,
"modes": [],
"moduleInstanceIds": [
"<string>"
],
"moduleNames": [
"<string>"
],
"setupConfigured": true,
"runtimeInputsRequired": true,
"hitlRequired": true,
"openWorkItemCount": 4503599627370495,
"requiredRuntimeFieldSources": [],
"missingSetupFieldsBySource": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"requiredFor": [],
"mapsTo": "<string>",
"enumValues": [
"<string>"
]
}
]
}
],
"issues": [
"<string>"
]
}
],
"openWorkItemCount": 4503599627370495,
"activeAvailCount": 4503599627370495
}
}Storefront
Create feed-backed modular source
Create a real seller modular inventory source backed by the uploaded/static avails-feed module and, by default, the built-in booking ledger. Execution, reporting, and creative backend details are stored as non-secret setup metadata until matching modules are configured.
POST
/
inventory-sources
/
modular
/
feed
Create feed-backed modular source
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/inventory-sources/modular/feed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'{
"inventorySourceId": "<string>",
"sourceId": "<string>",
"projection": {
"inventorySource": {
"id": "<string>",
"storefrontId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"executionType": "MODULAR_SOURCE",
"status": "<string>",
"healthStatus": "<string>",
"lastError": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"modules": [
{
"moduleRowId": "<string>",
"inventorySourceId": "<string>",
"moduleInstanceId": "<string>",
"name": "<string>",
"provider": "<string>",
"contractId": "<string>",
"contractVersion": "<string>",
"contract": {
"contractId": "<string>",
"version": "<string>",
"moduleType": "<string>",
"displayName": "<string>",
"description": "<string>",
"constraints": [
"<string>"
],
"provider": "<string>"
},
"configuredFieldKeys": [
"<string>"
],
"missingSetupFieldsBySource": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"requiredFor": [],
"mapsTo": "<string>",
"enumValues": [
"<string>"
]
}
]
}
],
"lifecycle": [
{
"description": "<string>",
"outputKeys": [
"<string>"
],
"requiredFieldsBySource": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"requiredFor": [],
"mapsTo": "<string>",
"enumValues": [
"<string>"
]
}
]
}
],
"missingSetupFieldsBySource": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"requiredFor": [],
"mapsTo": "<string>",
"enumValues": [
"<string>"
]
}
]
}
],
"moduleConfigReady": true,
"workItemKind": "<string>",
"taskContract": {
"taskId": "<string>",
"requiredInputKeys": [
"<string>"
],
"requiredResultKeys": [
"<string>"
],
"outputKeys": [
"<string>"
],
"retryable": true,
"blocksStage": true,
"workItemKind": "<string>",
"fallbackWorkItemKind": "<string>",
"operatorAction": "<string>",
"idempotencyKeyFields": [
"<string>"
]
}
}
],
"openWorkItemCount": 4503599627370495,
"openWorkItemCountsByKind": {},
"lastError": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"issues": [
"<string>"
]
}
],
"lifecycleSummary": [
{
"supported": true,
"modes": [],
"moduleInstanceIds": [
"<string>"
],
"moduleNames": [
"<string>"
],
"setupConfigured": true,
"runtimeInputsRequired": true,
"hitlRequired": true,
"openWorkItemCount": 4503599627370495,
"requiredRuntimeFieldSources": [],
"missingSetupFieldsBySource": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"requiredFor": [],
"mapsTo": "<string>",
"enumValues": [
"<string>"
]
}
]
}
],
"issues": [
"<string>"
]
}
],
"openWorkItemCount": 4503599627370495,
"activeAvailCount": 4503599627370495
}
}Authorizations
API key or access token
Body
application/json
Creates a real seller modular inventory source backed by an uploaded/static avails feed module and, by default, the built-in booking ledger. Execution, reporting, and creative backend details are stored as non-secret setup metadata until matching modules are configured.
Required string length:
1 - 255Required string length:
1 - 255Pattern:
^[a-z0-9][a-z0-9_-]*$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required string length:
1 - 2000⌘I