Create FreeWheel sandbox modular source
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/inventory-sources/modular/freewheel-sandbox \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sourceId": "<string>",
"name": "<string>",
"advertiserId": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/inventory-sources/modular/freewheel-sandbox"
payload = {
"sourceId": "<string>",
"name": "<string>",
"advertiserId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({sourceId: '<string>', name: '<string>', advertiserId: '<string>'})
};
fetch('https://api.interchange.io/api/v2/storefront/inventory-sources/modular/freewheel-sandbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefront
Create FreeWheel sandbox modular source
Create or update a FreeWheel sandbox modular inventory source backed by static avails, a booking ledger, and live FreeWheel taxonomy selector discovery. Credentials are platform-managed sandbox env vars; callers never supply credential values or env var names.
POST
/
inventory-sources
/
modular
/
freewheel-sandbox
Create FreeWheel sandbox modular source
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/inventory-sources/modular/freewheel-sandbox \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sourceId": "<string>",
"name": "<string>",
"advertiserId": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/inventory-sources/modular/freewheel-sandbox"
payload = {
"sourceId": "<string>",
"name": "<string>",
"advertiserId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({sourceId: '<string>', name: '<string>', advertiserId: '<string>'})
};
fetch('https://api.interchange.io/api/v2/storefront/inventory-sources/modular/freewheel-sandbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Body
application/json
Creates or updates a FreeWheel sandbox modular inventory source. Credentials are platform-managed sandbox environment variables, not caller-supplied secrets or env var names.
⌘I