> ## 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.

# Register an Inventory Feed capability

> Idempotently register an exact ratified HITL or API-push capability. The server derives the canonical v1 feed key, proves the module assignment, and returns authenticated REST data-plane paths without issuing credentials or returning feed bytes.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml post /inventory-sources/{sourceId}/feeds
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}/feeds:
    post:
      tags:
        - Storefront
      summary: Register an Inventory Feed capability
      description: >-
        Idempotently register an exact ratified HITL or API-push capability. The
        server derives the canonical v1 feed key, proves the module assignment,
        and returns authenticated REST data-plane paths without issuing
        credentials or returning feed bytes.
      operationId: createInventoryFeed
      parameters:
        - in: path
          name: sourceId
          schema:
            description: Inventory source ID
            type: string
            minLength: 1
          required: true
          description: Inventory source ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInventoryFeedBody'
      responses:
        '200':
          description: Register an Inventory Feed capability
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInventoryFeedResponse'
        '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:
    CreateInventoryFeedBody:
      description: >-
        Registers (or idempotently retrieves) an Inventory Feed record. The
        server resolves the exact ratified profile capability and eligible
        INVENTORY_FEED module. The canonical key is always
        canonicalProfile.profileId:canonicalProfile.profileVersion.
      type: object
      properties:
        profileId:
          description: >-
            Profile identifier (e.g. "wholesale-avails-pricing",
            "static-avails-feed"). Must be a registered, ratified profile.
          type: string
          minLength: 1
        profileVersion:
          description: Profile version (e.g. "v1").
          type: string
          minLength: 1
      required:
        - profileId
        - profileVersion
      additionalProperties: false
    CreateInventoryFeedResponse:
      description: >-
        Canonical feed identity, exact capability evidence, module assignment,
        and authenticated REST data-plane paths.
      type: object
      properties:
        feedId:
          type: string
          minLength: 1
        feedKey:
          type: string
          minLength: 1
        inventorySourceId:
          type: string
          minLength: 1
        inventorySourceModuleId:
          type: string
          minLength: 1
        canonicalProfile:
          type: object
          properties:
            profileId:
              type: string
              minLength: 1
            profileVersion:
              type: string
              minLength: 1
            transport:
              type: string
              enum:
                - HITL
                - API_PUSH
                - BESPOKE_PULL
          required:
            - profileId
            - profileVersion
            - transport
          additionalProperties: false
        requestedCapability:
          type: object
          properties:
            profileId:
              type: string
              minLength: 1
            profileVersion:
              type: string
              minLength: 1
            transport:
              type: string
              enum:
                - HITL
                - API_PUSH
                - BESPOKE_PULL
          required:
            - profileId
            - profileVersion
            - transport
          additionalProperties: false
        registrationTransport:
          type: string
          enum:
            - HITL
            - API_PUSH
            - BESPOKE_PULL
        deliverySemantics:
          type: string
          enum:
            - FULL_REPLACEMENT
            - PATCH_UPSERT
        moduleAssignment:
          type: object
          properties:
            assignmentId:
              type: string
              minLength: 1
            contractId:
              type: string
              enum:
                - static-avails-feed:v1
                - wholesale-avails-pricing:v1
            contractVersion:
              type: string
              minLength: 1
            provider:
              type: string
              minLength: 1
          required:
            - assignmentId
            - contractId
            - contractVersion
            - provider
          additionalProperties: false
        dataPlane:
          type: object
          properties:
            authentication:
              type: object
              properties:
                scheme:
                  type: string
                  enum:
                    - BEARER
                scope:
                  type: string
                  enum:
                    - TENANT_STOREFRONT
              required:
                - scheme
                - scope
              additionalProperties: false
            paths:
              type: object
              properties:
                preview:
                  type: string
                  minLength: 1
                upload:
                  type: string
                  minLength: 1
                commit:
                  type: string
                  minLength: 1
                push:
                  type: string
                  minLength: 1
              additionalProperties: false
          required:
            - authentication
            - paths
          additionalProperties: false
        unsupportedOperations:
          type: array
          items:
            type: object
            properties:
              operation:
                type: string
                enum:
                  - PULL
                  - SCHEDULE
                  - PROVIDER_TRIGGER
                  - CREDENTIAL_ISSUANCE
                  - CREDENTIAL_ROTATION
                  - CREDENTIAL_REVOCATION
                  - SIGNED_TRANSFER
              code:
                type: string
                enum:
                  - UNSUPPORTED_OPERATION
              reason:
                type: string
                minLength: 1
            required:
              - operation
              - code
              - reason
            additionalProperties: false
      required:
        - feedId
        - feedKey
        - inventorySourceId
        - inventorySourceModuleId
        - canonicalProfile
        - requestedCapability
        - registrationTransport
        - deliverySemantics
        - moduleAssignment
        - dataPlane
        - unsupportedOperations
      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

````