> ## 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. # Get an inventory source mapping workspace > Project shared Storefront identities through one exact inventory Source, with independent Storefront-built and Agent-supplied ownership, readiness, and retained inactive product-path state. This preview is hidden unless source-mapping-workspaces is enabled. ## OpenAPI ````yaml /v2/storefront-api-v2.yaml get /inventory-sources/{sourceId}/mapping-workspace openapi: 3.0.0 info: title: Scope3 Storefront API version: 2.0.0 description: |- REST API for partners to manage storefronts, inventory sources, and billing. ## Authentication All endpoints require a Bearer token in the Authorization header: ``` Authorization: Bearer your-api-key ``` ## Base URL `https://api.interchange.io/api/v2/storefront` ## For AI Agents AI agents can use the MCP endpoint at `/mcp/v2/storefront` with three tools: - `initialize`: Start an MCP session - `api_call`: Make REST API calls - `ask_about_capability`: Learn about API features servers: - url: https://api.interchange.io/api/v2/storefront description: Production server security: [] tags: - name: Account description: Account management, service tokens, and preferences - name: Asks description: >- What you are waiting on Scope3 for — support, product, and supply asks in one list - name: Storefront description: Manage storefront and inventory sources - name: Storefront Agents description: List and manage registered sales, signals, and outcomes agents - name: Storefront Activity description: Audit log of configuration and inventory changes on the storefront - name: Storefront Billing description: Payout bank details and billing configuration for storefronts - name: AI Usage description: Storefront AI token usage visibility by model - name: MCP description: Model Context Protocol endpoints paths: /inventory-sources/{sourceId}/mapping-workspace: get: tags: - Storefront summary: Get an inventory source mapping workspace description: >- Project shared Storefront identities through one exact inventory Source, with independent Storefront-built and Agent-supplied ownership, readiness, and retained inactive product-path state. This preview is hidden unless source-mapping-workspaces is enabled. operationId: getInventorySourceMappingWorkspace parameters: - in: path name: sourceId schema: description: Inventory source ID type: string minLength: 1 required: true description: Inventory source ID responses: '200': description: Get an inventory source mapping workspace content: application/json: schema: $ref: '#/components/schemas/InventorySourceMappingWorkspaceResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- FEATURE_NOT_ENABLED (the source-mapping-workspaces preview is off for this customer). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: >- NOT_FOUND (the inventory source does not exist or is not visible to this customer). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: >- SERVICE_UNAVAILABLE (the rollout evaluation or mapping workspace read is temporarily unavailable). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: InventorySourceMappingWorkspaceResponse: description: >- Mode-aware, source-scoped mapping workspace. Shared identity counts are Storefront projections; source and mapped counts never imply coverage by another Source. type: object properties: source: type: object properties: id: type: string sourceId: type: string name: type: string status: type: string enum: - PENDING - ACTIVE - DISABLED executionType: type: string declaredAgentProductMode: nullable: true type: string enum: - WHOLESALE - COMPOSING - BOTH bindingProductMode: nullable: true type: string enum: - WHOLESALE - COMPOSING - BOTH effectiveProductMode: nullable: true type: string enum: - WHOLESALE - COMPOSING - BOTH runtimeReasons: type: array items: type: string enum: - SOURCE_NOT_ACTIVE - AGENT_BINDING_MISSING - AGENT_MODE_UNDECLARED - BOTH_SELECTION_REQUIRED - MERCHANDISING_ACCESS_INACTIVE - WHOLESALE_CATALOG_NOT_READY required: - id - sourceId - name - status - executionType - declaredAgentProductMode - bindingProductMode - effectiveProductMode - runtimeReasons additionalProperties: false productPaths: type: array items: type: object properties: productPath: type: string enum: - WHOLESALE - COMPOSING active: type: boolean runtimeReady: type: boolean runtimeReasons: type: array items: type: string enum: - SOURCE_NOT_ACTIVE - AGENT_BINDING_MISSING - AGENT_MODE_UNDECLARED - BOTH_SELECTION_REQUIRED - MERCHANDISING_ACCESS_INACTIVE - WHOLESALE_CATALOG_NOT_READY sections: type: array items: type: object properties: id: type: string enum: - connection - inventory - properties - formats - pricing - advertisers - diagnostics label: type: string owner: type: string enum: - SUPPLIED_BY_CONNECTED_AGENT - MANAGED_BY_SCOPE3_ADAPTER - CONFIGURED_IN_STOREFRONT - NEEDS_SELLER_MAPPING - NEEDS_SCOPE3_RECONCILIATION access: type: string enum: - READ_ONLY - UNAVAILABLE state: nullable: true type: string enum: - READY - NEEDS_ATTENTION - EMPTY - RETAINED_INACTIVE summary: type: string counts: type: object properties: shared: nullable: true type: integer minimum: 0 maximum: 9007199254740991 source: nullable: true type: integer minimum: 0 maximum: 9007199254740991 mapped: nullable: true type: integer minimum: 0 maximum: 9007199254740991 required: - shared - source - mapped additionalProperties: false nextAction: nullable: true type: object properties: label: type: string owner: type: string enum: - SELLER - CONNECTED_AGENT - SCOPE3 path: nullable: true type: string format: uri pattern: ^https:\/\/.* required: - label - owner - path additionalProperties: false required: - id - label - owner - access - state - summary - counts - nextAction additionalProperties: false required: - productPath - active - runtimeReady - runtimeReasons - sections additionalProperties: false storefrontProjection: type: object properties: properties: type: object properties: shared: nullable: true type: integer minimum: 0 maximum: 9007199254740991 source: nullable: true type: integer minimum: 0 maximum: 9007199254740991 mapped: nullable: true type: integer minimum: 0 maximum: 9007199254740991 required: - shared - source - mapped additionalProperties: false formats: type: object properties: shared: nullable: true type: integer minimum: 0 maximum: 9007199254740991 source: nullable: true type: integer minimum: 0 maximum: 9007199254740991 mapped: nullable: true type: integer minimum: 0 maximum: 9007199254740991 required: - shared - source - mapped additionalProperties: false advertisers: type: object properties: shared: nullable: true type: integer minimum: 0 maximum: 9007199254740991 source: nullable: true type: integer minimum: 0 maximum: 9007199254740991 mapped: nullable: true type: integer minimum: 0 maximum: 9007199254740991 required: - shared - source - mapped additionalProperties: false required: - properties - formats - advertisers additionalProperties: false generatedAt: type: string format: date-time 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))$ required: - source - productPaths - storefrontProjection - generatedAt additionalProperties: false ErrorResponse: description: Standard error response type: object properties: data: type: string nullable: true enum: - null error: $ref: '#/components/schemas/ApiError' required: - data - error additionalProperties: false ApiError: description: Structured error object type: object properties: code: description: Machine-readable error code type: string message: description: Human-readable error message type: string field: description: Field path associated with the error type: string details: description: Additional error context type: object additionalProperties: {} required: - code - message additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: API key or access token ````