> ## 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 a canonical proposal artifact

> Fetch one proposal artifact including the exact response envelope and the resolved immutable product snapshots for every referenced product.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml get /proposal-artifacts/{id}
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: 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:
  /proposal-artifacts/{id}:
    get:
      tags:
        - Storefront
      summary: Get a canonical proposal artifact
      description: >-
        Fetch one proposal artifact including the exact response envelope and
        the resolved immutable product snapshots for every referenced product.
      operationId: getProposalArtifact
      parameters:
        - in: path
          name: id
          schema:
            description: Artifact id (UUID).
            example: 5f0c2a54-9c1b-4f0e-8a9d-3f4b2f4a1c11
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          required: true
          description: Artifact id (UUID).
      responses:
        '200':
          description: Get a canonical proposal artifact
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProposalArtifactResponse'
        '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:
    GetProposalArtifactResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ProposalArtifact'
      required:
        - data
      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
    ProposalArtifact:
      description: >-
        The canonical outbound proposal: exact response envelope + immutable
        product snapshots, with brief/run lineage.
      type: object
      properties:
        id:
          type: string
        storefrontId:
          type: string
        buyerCustomerId:
          nullable: true
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        briefArtifactId:
          description: >-
            The brief artifact this proposal answered; null when the brief
            capture failed (the link is soft and never invented).
          nullable: true
          type: string
        chefComposeRunId:
          description: >-
            The intelligence run that composed this proposal; null when the run
            record failed.
          nullable: true
          type: string
        version:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        supersedesArtifactId:
          nullable: true
          type: string
        schemaVersion:
          type: string
        redactionManifest:
          $ref: '#/components/schemas/ExchangeArtifactRedactionManifest'
        digest:
          type: string
        byteSize:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        complete:
          type: boolean
        createdAt:
          type: string
        response:
          description: >-
            The exact response envelope the buyer received; null when
            complete=false.
          nullable: true
        productSnapshots:
          description: >-
            Resolved immutable product snapshots keyed by product id; null when
            complete=false.
          nullable: true
      required:
        - id
        - storefrontId
        - buyerCustomerId
        - briefArtifactId
        - chefComposeRunId
        - version
        - supersedesArtifactId
        - schemaVersion
        - redactionManifest
        - digest
        - byteSize
        - complete
        - createdAt
        - response
        - productSnapshots
      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
    ExchangeArtifactRedactionManifest:
      description: Discloses exactly what was removed or dropped from the stored payload.
      type: object
      properties:
        redactedPaths:
          description: >-
            JSON paths removed from the payload before storage (secret-bearing
            keys).
          type: array
          items:
            type: string
        truncated:
          description: >-
            Present when a payload exceeded its size limit and was dropped (the
            row remains with complete=false).
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              reason:
                type: string
              originalByteSize:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
            required:
              - field
              - reason
              - originalByteSize
            additionalProperties: false
      required:
        - redactedPaths
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````