> ## Documentation Index > Fetch the complete documentation index at: https://docs.apostra.com/llms.txt > Use this file to discover all available pages before exploring further. # Get the active operating-instructions version > Return the version currently advertised as active for the storefront. Returns 404 when no version has been activated. ## OpenAPI ````yaml /v2/storefront-api-v2.yaml get /operating-instructions/active openapi: 3.0.0 info: title: Scope3 Storefront API version: 2.0.0 description: >- REST API for partners to manage Seller Accounts, 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 Seller Accounts - name: AI Usage description: Seller Account AI token usage visibility by model - name: MCP description: Model Context Protocol endpoints paths: /operating-instructions/active: get: tags: - Storefront summary: Get the active operating-instructions version description: >- Return the version currently advertised as active for the storefront. Returns 404 when no version has been activated. operationId: getActiveOperatingInstructions responses: '200': description: Get the active operating-instructions version content: application/json: schema: $ref: '#/components/schemas/OperatingInstructionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: OperatingInstructionsResponse: type: object properties: id: type: string description: Surrogate id of the version row (BIGINT serialized as string). example: '42' storefrontId: type: string description: Storefront the version belongs to (BIGINT serialized as string). example: '1234' version: type: integer minimum: 1 maximum: 9007199254740991 description: >- Per-storefront version number. Monotone, never reused. The first version a storefront authors is 1. example: 3 content: type: string description: Markdown body consumed by the Merchandising Agent. notes: nullable: true description: Operator note about why this version was authored. type: string isActive: type: boolean description: >- Whether this version is the Storefront's active operating instructions (the version the Merchandising Agent will use on the next composition). createdAt: 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))$ description: >- Creation timestamp (ISO 8601). Rows are immutable so there is no updatedAt. createdBy: nullable: true description: >- User id of the operator who authored the version (BIGINT serialized as string). Null when authored by a system or service-token caller. type: string ownershipIssues: type: array items: type: object properties: area: type: string enum: - pricing - discounts - markets - acceptance_policy canonicalOwner: type: string enum: - selling_terms - buyer_discounts - business_profile - acceptance_policy canonicalSurface: type: string enum: - playbook_pricing - buyer_discounts - discovery_card - business_rules message: type: string required: - area - canonicalOwner - canonicalSurface - message additionalProperties: false description: >- Canonical-ownership conflicts detected in this immutable version. Empty for versions that keep pricing, discounts, markets, and acceptance facts in their owning storefront surfaces. doctrine: description: >- The selling doctrine this version composes under (AI-5870) — always resolved, never null: a version that stored none reads the platform default with `isDefault: true`. allOf: - $ref: '#/components/schemas/SellingDoctrineResponse' required: - id - storefrontId - version - content - notes - isActive - createdAt - createdBy - ownershipIssues - doctrine additionalProperties: false description: >- A single operating-instructions version for a storefront. Versions are immutable; updates produce a new row. ErrorResponse: type: object properties: data: type: string nullable: true enum: - null error: $ref: '#/components/schemas/ApiError' required: - data - error additionalProperties: false description: Standard error response SellingDoctrineResponse: type: object properties: variant: type: string enum: - house_default - premium_scarcity_house - volume_partner - consultative - custom thresholds: $ref: '#/components/schemas/SellingDoctrineThresholds' isDefault: type: boolean description: >- True when this version carries no stored doctrine and the platform default is standing in. A storefront is "configured" for doctrine purposes only once this is false on its active version. required: - variant - thresholds - isDefault additionalProperties: false description: >- The doctrine an operating-instructions version carries, always resolved: a version with none reads the platform default with `isDefault: true`, so a reader never has to decide what absence means. ApiError: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable error message field: description: Field path associated with the error type: string details: description: Additional error context type: object additionalProperties: {} required: - code - message additionalProperties: false description: Structured error object SellingDoctrineThresholds: type: object properties: minimumCategoryFit: type: number minimum: 0 maximum: 1 description: >- The share of the brief's stated category and channel terms this catalogue must actually serve before the seller pitches in full. 1 means only a brief the catalogue covers completely earns a pitch; 0 means every brief does. counterAppetite: type: number minimum: 0 maximum: 1 description: >- How far below the pitch bar the seller will still answer, with a counter-pitch instead of a pass. 0 never counters — a brief that misses the bar is declined. 1 counters everything the catalogue touches at all. floorPosture: type: string enum: - hold_floor - flex_floor description: >- What to do when the buyer states a budget and no composed line could be priced. 'hold_floor' declines rather than negotiate from nothing; 'flex_floor' counters and invites a re-brief. required: - minimumCategoryFit - counterAppetite - floorPosture additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: API key or access token ````