> ## Documentation Index > Fetch the complete documentation index at: https://docs.semicola.com/llms.txt > Use this file to discover all available pages before exploring further. # A modular source's runtime projection: modules, lifecycle stages, active avails, catalog-mapping readiness ## OpenAPI ````yaml /openapi/storefront.yaml get /api/v2/storefront/inventory-sources/{id}/modular openapi: 3.1.0 info: title: Semicola Exchange storefront API version: 2.0.0 description: >- Seller (storefront) endpoints: storefront setup, inventory sources, products, AI Business Rules, playbook, demand inbox, proposals, approvals and seller reporting. servers: - url: https://api.semicola.com security: - bearerAuth: [] - sessionCookie: [] tags: - name: Storefront - name: Inventory Sources - name: Publisher Domains - name: Products - name: Business Rules - name: Playbook - name: Library - name: Demand Inbox - name: Proposals - name: Approvals - name: Creative Reviews - name: Media Buys - name: Buyers - name: Reporting - name: Activity - name: Test Runs paths: /api/v2/storefront/inventory-sources/{id}/modular: get: tags: - Inventory Sources summary: >- A modular source's runtime projection: modules, lifecycle stages, active avails, catalog-mapping readiness operationId: getStorefrontInventorySourcesByIdModular parameters: - name: id in: path required: true schema: type: string minLength: 1 responses: '200': description: OK content: application/json: schema: type: object properties: data: anyOf: - type: object properties: inventorySource: type: object properties: id: type: string storefrontId: type: string sourceId: type: string name: type: string executionType: type: string const: MODULAR_SOURCE status: type: string healthStatus: type: string lastError: type: - string - 'null' lastCheckedAt: type: - string - 'null' verificationMode: type: string enum: - LIVE_SOURCE - LOCAL_SYNTHETIC required: - id - storefrontId - sourceId - name - executionType - status - healthStatus - lastError - lastCheckedAt - verificationMode additionalProperties: false modules: type: array items: type: object properties: moduleRowId: type: string inventorySourceId: type: string moduleInstanceId: type: string kind: type: string enum: - INVENTORY_FEED - BOOKING_LEDGER - TRAFFICKING - STATUS_SYNC - REPORTING_IMPORT name: type: string provider: type: - string - 'null' status: type: string enum: - CONFIGURING - ACTIVE - DISABLED - ERROR contractId: type: - string - 'null' contractVersion: type: - string - 'null' contract: type: 'null' configuredFieldKeys: type: array items: type: string missingSetupFieldsBySource: type: array items: type: object properties: source: type: string enum: - MODULE_CONFIG - INVENTORY_FEED - PRODUCT_METADATA - MEDIA_BUY_INPUT - CREATIVE_INPUT - REPORTING_UPLOAD - SYSTEM - MODULE_RESULT fields: type: array items: type: object properties: key: type: string label: type: string description: type: string source: type: string enum: - MODULE_CONFIG - INVENTORY_FEED - PRODUCT_METADATA - MEDIA_BUY_INPUT - CREATIVE_INPUT - REPORTING_UPLOAD - SYSTEM - MODULE_RESULT valueType: type: string required: type: boolean requiredFor: type: array items: type: string enum: - LIST_ACCOUNTS - INGEST_AVAILS - SYNC_INVENTORY - GET_PRODUCTS - GET_MEDIA_BUYS - GET_ACCOUNT_RESOURCES - RESERVE_AVAILS - FINALIZE_BOOKING - RELEASE_BOOKING - RECONCILE_DELIVERY - SYNC_CREATIVES - TRAFFIC_CAMPAIGN - UPDATE_CAMPAIGN - SYNC_STATUS - IMPORT_REPORTING required: - key - label - description - source - valueType - required - requiredFor additionalProperties: false required: - source - fields additionalProperties: false lifecycle: type: array items: type: object properties: stage: type: string enum: - LIST_ACCOUNTS - INGEST_AVAILS - SYNC_INVENTORY - GET_PRODUCTS - GET_MEDIA_BUYS - GET_ACCOUNT_RESOURCES - RESERVE_AVAILS - FINALIZE_BOOKING - RELEASE_BOOKING - RECONCILE_DELIVERY - SYNC_CREATIVES - TRAFFIC_CAMPAIGN - UPDATE_CAMPAIGN - SYNC_STATUS - IMPORT_REPORTING mode: type: string enum: - AUTOMATED - HITL - UNSUPPORTED description: type: string workItemKind: type: string outputKeys: type: array items: type: string requiredFieldsBySource: type: array items: type: object properties: source: type: string enum: - MODULE_CONFIG - INVENTORY_FEED - PRODUCT_METADATA - MEDIA_BUY_INPUT - CREATIVE_INPUT - REPORTING_UPLOAD - SYSTEM - MODULE_RESULT fields: type: array items: type: object properties: key: type: string label: type: string description: type: string source: type: string enum: - MODULE_CONFIG - INVENTORY_FEED - PRODUCT_METADATA - MEDIA_BUY_INPUT - CREATIVE_INPUT - REPORTING_UPLOAD - SYSTEM - MODULE_RESULT valueType: type: string required: type: boolean requiredFor: type: array items: type: string enum: - LIST_ACCOUNTS - INGEST_AVAILS - SYNC_INVENTORY - GET_PRODUCTS - GET_MEDIA_BUYS - GET_ACCOUNT_RESOURCES - RESERVE_AVAILS - FINALIZE_BOOKING - RELEASE_BOOKING - RECONCILE_DELIVERY - SYNC_CREATIVES - TRAFFIC_CAMPAIGN - UPDATE_CAMPAIGN - SYNC_STATUS - IMPORT_REPORTING required: - key - label - description - source - valueType - required - requiredFor additionalProperties: false required: - source - fields additionalProperties: false missingSetupFieldsBySource: type: array items: type: object properties: source: type: string enum: - MODULE_CONFIG - INVENTORY_FEED - PRODUCT_METADATA - MEDIA_BUY_INPUT - CREATIVE_INPUT - REPORTING_UPLOAD - SYSTEM - MODULE_RESULT fields: type: array items: type: object properties: key: type: string label: type: string description: type: string source: type: string enum: - MODULE_CONFIG - INVENTORY_FEED - PRODUCT_METADATA - MEDIA_BUY_INPUT - CREATIVE_INPUT - REPORTING_UPLOAD - SYSTEM - MODULE_RESULT valueType: type: string required: type: boolean requiredFor: type: array items: type: string enum: - LIST_ACCOUNTS - INGEST_AVAILS - SYNC_INVENTORY - GET_PRODUCTS - GET_MEDIA_BUYS - GET_ACCOUNT_RESOURCES - RESERVE_AVAILS - FINALIZE_BOOKING - RELEASE_BOOKING - RECONCILE_DELIVERY - SYNC_CREATIVES - TRAFFIC_CAMPAIGN - UPDATE_CAMPAIGN - SYNC_STATUS - IMPORT_REPORTING required: - key - label - description - source - valueType - required - requiredFor additionalProperties: false required: - source - fields additionalProperties: false moduleConfigReady: type: boolean required: - stage - mode - description - outputKeys - requiredFieldsBySource - missingSetupFieldsBySource - moduleConfigReady additionalProperties: false openWorkItemCount: type: integer minimum: 0 maximum: 9007199254740991 openWorkItemCountsByKind: type: object propertyNames: type: string additionalProperties: type: integer minimum: 0 maximum: 9007199254740991 lastError: type: - string - 'null' lastCheckedAt: type: - string - 'null' issues: type: array items: type: string required: - moduleRowId - inventorySourceId - moduleInstanceId - kind - name - provider - status - contractId - contractVersion - contract - configuredFieldKeys - missingSetupFieldsBySource - lifecycle - openWorkItemCount - openWorkItemCountsByKind - lastError - lastCheckedAt - issues additionalProperties: false lifecycleSummary: type: array items: type: object properties: stage: type: string enum: - LIST_ACCOUNTS - INGEST_AVAILS - SYNC_INVENTORY - GET_PRODUCTS - GET_MEDIA_BUYS - GET_ACCOUNT_RESOURCES - RESERVE_AVAILS - FINALIZE_BOOKING - RELEASE_BOOKING - RECONCILE_DELIVERY - SYNC_CREATIVES - TRAFFIC_CAMPAIGN - UPDATE_CAMPAIGN - SYNC_STATUS - IMPORT_REPORTING supported: type: boolean status: type: string enum: - UNSUPPORTED - NOT_DECLARED - MISSING_SETUP - RUNTIME_INPUTS_REQUIRED - HITL_PENDING - READY - BLOCKED modes: type: array items: type: string enum: - AUTOMATED - HITL - UNSUPPORTED moduleInstanceIds: type: array items: type: string moduleNames: type: array items: type: string setupConfigured: type: boolean runtimeInputsRequired: type: boolean hitlRequired: type: boolean openWorkItemCount: type: integer minimum: 0 maximum: 9007199254740991 requiredRuntimeFieldSources: type: array items: type: string enum: - MODULE_CONFIG - INVENTORY_FEED - PRODUCT_METADATA - MEDIA_BUY_INPUT - CREATIVE_INPUT - REPORTING_UPLOAD - SYSTEM - MODULE_RESULT missingSetupFieldsBySource: type: array items: type: object properties: source: type: string enum: - MODULE_CONFIG - INVENTORY_FEED - PRODUCT_METADATA - MEDIA_BUY_INPUT - CREATIVE_INPUT - REPORTING_UPLOAD - SYSTEM - MODULE_RESULT fields: type: array items: type: object properties: key: type: string label: type: string description: type: string source: type: string enum: - MODULE_CONFIG - INVENTORY_FEED - PRODUCT_METADATA - MEDIA_BUY_INPUT - CREATIVE_INPUT - REPORTING_UPLOAD - SYSTEM - MODULE_RESULT valueType: type: string required: type: boolean requiredFor: type: array items: type: string enum: - LIST_ACCOUNTS - INGEST_AVAILS - SYNC_INVENTORY - GET_PRODUCTS - GET_MEDIA_BUYS - GET_ACCOUNT_RESOURCES - RESERVE_AVAILS - FINALIZE_BOOKING - RELEASE_BOOKING - RECONCILE_DELIVERY - SYNC_CREATIVES - TRAFFIC_CAMPAIGN - UPDATE_CAMPAIGN - SYNC_STATUS - IMPORT_REPORTING required: - key - label - description - source - valueType - required - requiredFor additionalProperties: false required: - source - fields additionalProperties: false issues: type: array items: type: string required: - stage - supported - status - modes - moduleInstanceIds - moduleNames - setupConfigured - runtimeInputsRequired - hitlRequired - openWorkItemCount - requiredRuntimeFieldSources - missingSetupFieldsBySource - issues additionalProperties: false openWorkItemCount: type: integer minimum: 0 maximum: 9007199254740991 activeAvailCount: type: integer minimum: 0 maximum: 9007199254740991 catalogMappingReadiness: type: object properties: verificationMode: type: string enum: - LIVE_SOURCE - LOCAL_SYNTHETIC sections: type: array items: type: object properties: id: type: string enum: - SET_UP_INVENTORY - MAKE_IT_MERCHANDISABLE - PROVE_IT title: type: string enum: - Set up inventory - Make it merchandisable - Prove it rows: type: array items: type: object properties: id: type: string title: type: string requirement: type: string enum: - REQUIRED - RECOMMENDED - NOT_APPLICABLE status: anyOf: - type: string enum: - NOT_STARTED - IN_PROGRESS - READY - NEEDS_ATTENTION - BLOCKED - type: 'null' evidence: type: array items: type: object properties: code: type: string summary: type: string value: type: - string - number - boolean observedAt: type: - string - 'null' required: - code - summary - observedAt additionalProperties: false freshness: type: object properties: state: type: string enum: - FRESH - STALE - UNAVAILABLE observedAt: type: - string - 'null' required: - state - observedAt additionalProperties: false sourceOfTruth: type: string enum: - INVENTORY_SOURCE - INVENTORY_FEED - PROPERTY_ROSTER - INVENTORY_COMPONENTS - PRODUCT_CATALOG - PRICING - PLAYBOOK - BUSINESS_RULES - DECISIONING_INPUTS - SOURCE_PROOF action: anyOf: - oneOf: - type: object properties: operation: type: string const: open_modular_avails_commit arguments: type: object properties: sourceId: type: string required: - sourceId additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: open_property_roster arguments: type: object properties: {} additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: get_modular_inventory_source_readiness arguments: type: object properties: sourceId: type: string required: - sourceId additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: get_playbook arguments: type: object properties: {} additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: get_business_rules arguments: type: object properties: {} additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: test_storefront_brief arguments: type: object properties: sourceId: type: string required: - sourceId additionalProperties: false required: - operation - arguments additionalProperties: false - type: 'null' externalOwner: anyOf: - type: string enum: - PUBLISHER - SEMICOLA - VENDOR - type: 'null' diagnostics: type: array items: type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false required: - id - title - requirement - status - evidence - freshness - sourceOfTruth - action - externalOwner - diagnostics additionalProperties: false required: - id - title - rows additionalProperties: false progress: type: object properties: ready: type: integer minimum: -9007199254740991 maximum: 9007199254740991 applicable: type: integer minimum: -9007199254740991 maximum: 9007199254740991 percent: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - ready - applicable - percent additionalProperties: false requiredProgress: type: object properties: ready: type: integer minimum: -9007199254740991 maximum: 9007199254740991 applicable: type: integer minimum: -9007199254740991 maximum: 9007199254740991 percent: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - ready - applicable - percent additionalProperties: false nextAction: anyOf: - oneOf: - type: object properties: operation: type: string const: open_modular_avails_commit arguments: type: object properties: sourceId: type: string required: - sourceId additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: open_property_roster arguments: type: object properties: {} additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: get_modular_inventory_source_readiness arguments: type: object properties: sourceId: type: string required: - sourceId additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: get_playbook arguments: type: object properties: {} additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: get_business_rules arguments: type: object properties: {} additionalProperties: false required: - operation - arguments additionalProperties: false - type: object properties: operation: type: string const: test_storefront_brief arguments: type: object properties: sourceId: type: string required: - sourceId additionalProperties: false required: - operation - arguments additionalProperties: false - type: 'null' required: - verificationMode - sections - progress - requiredProgress - nextAction additionalProperties: false required: - inventorySource - modules - lifecycleSummary - openWorkItemCount - activeAvailCount - catalogMappingReadiness additionalProperties: false - type: 'null' error: anyOf: - type: object properties: code: type: string message: type: string field: type: string details: {} required: - code - message additionalProperties: false - type: 'null' required: - data - error additionalProperties: false default: description: >- Error envelope `{data: null, error: {code, message, field?, details?}}`. components: securitySchemes: bearerAuth: type: http scheme: bearer description: API key or OAuth access token. sessionCookie: type: apiKey in: cookie name: sc_session ````