Skip to main content
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>"
}
'
{
  "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

Authorization
string
header
required

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.

sourceId
string
Required string length: 1 - 255
name
string
Required string length: 1 - 255
advertiserId
string
Required string length: 1 - 255

Response

Create FreeWheel sandbox modular source

inventorySourceId
string
required
sourceId
string
required
projection
object
required

Operator-facing setup-state projection for a modular inventory source.