FUSE Health Products & Catalog API

openapi: 3.2.0
info:
  title: FUSE Brand API (External) Products & Catalog API
  version: 1.0.0
  description: 'Server-to-server API exposing the FUSE brand-admin surface so a single brand/tenant can build its own admin frontend. Every request is authenticated with an API key bound to exactly one clinic; all data is auto-scoped to that clinic and cannot reach another brand''s data. Isolation is enforced by application-layer clinic filtering on every query.


    COVERAGE: 218 operations across 180 paths, and EVERY ONE is available to every brand. There is no per-clinic enablement step. What governs access: your API key and its scopes, the clinic the key belongs to (every read and write is filtered to it), your plan''s entitlements for the two commercially-gated areas — Affiliates (`AFFILIATES_TIER_REQUIRED`) and CRM Connect (`CRM_TIER_REQUIRED`) — and rate limits.


    AUTH: the external /api/v1 surface uses an API key (`x-api-key`, ApiKeyAuth). Key management (/api-keys) and /auth/signin live at the API root and use a brand-admin JWT (BearerAuth); /auth/signin itself is unauthenticated.


    SCOPES: every key carries scopes; read-only is the default and mutating endpoints require the `write` scope (403 INSUFFICIENT_SCOPE otherwise). Keys default to a 1-year expiry.


    RATE LIMITING: every endpoint may additionally return `429 Too Many Requests` with a `Retry-After` header; 429 is not repeated on each operation below.


    PLATFORM FIELDS: product cost, fees, pharmacy routing, doctor questions and FUSE approvals are set by FUSE, not by the brand. Any write (POST/PUT/PATCH/DELETE) whose JSON body carries one of those fields at any depth — for example `pharmacyPrice`, `shippingFeeUsd`, `coolerFeeUsd`, `pharmacyId`, `preferredPharmacyId`, `pharmacyProvider`, `requiredDoctorQuestions`, `facilitationFee`, `placeholderPrice`, `legalBusinessName`, `isTemplate` or `tenantManagerApproved` — is refused with `403 PLATFORM_FIELD`, whose `fields` array lists the offending paths; remove them and resend. (One exception: `POST /api/v1/products` still accepts the `pharmacyPrice` its schema requires, and ignores it.) 403 PLATFORM_FIELD is not repeated on each operation below.'
servers:
- url: https://api-dev.fusehealth.com
  description: Development
- url: https://api.fusehealth.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Products & Catalog
paths:
  /api/v1/products/{id}/upload-image:
    post:
      tags:
      - Products & Catalog
      summary: Upload or remove a product's image
      operationId: postApiV1ProductsIdUploadImage
      description: Uploads (multipart) or removes a product image for one of the key clinic's own products. Write-scoped, S3-backed.
      security:
      - ApiKeyAuth: []
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: false
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                image:
                  type: string
                  format: binary
          application/json:
            schema:
              type: object
              properties:
                removeImage:
                  type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/public/products/{productId}/pharmacy-coverages:
    get:
      tags:
      - Products & Catalog
      summary: List a product's pharmacy coverages (clinic-scoped)
      operationId: getApiV1PublicProductsProductIdPharmacyCoverages
      description: Pharmacy coverages for a product owned by the key's clinic (or a shared platform product). 404 for unknown/cross-brand/non-UUID id.
      security:
      - ApiKeyAuth: []
      parameters:
      - in: path
        name: productId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/catalog:
    get:
      tags:
      - Products & Catalog
      summary: Storefront catalog (light view) — same source as the brand portal
      operationId: getApiV1Catalog
      description: Storefront catalog (light view) — same source as the brand portal.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 200
        example: '200'
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
        example: '0'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogProduct'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/products:
    get:
      tags:
      - Products & Catalog
      summary: Product management view (clinic's own + shared platform products)
      operationId: getApiV1Products
      description: Product management view (clinic's own + shared platform products).
      security:
      - ApiKeyAuth: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
        example: '1'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
        example: '50'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Product'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      tags:
      - Products & Catalog
      summary: Create a custom product for the key clinic's brand
      operationId: postApiV1Products
      description: Creates a legacy Product owned by the key clinic's brand (brandId-scoped). No Stripe side-effect. Write-scoped.
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - pharmacyPrice
              - pharmacyProductId
              properties:
                name:
                  type: string
                description:
                  type: string
                pharmacyPrice:
                  type: number
                pharmacyProductId:
                  type: string
                isActive:
                  type: boolean
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/products/{id}:
    get:
      tags:
      - Products & Catalog
      summary: One product (accepts a Product id or a GlobalProduct id)
      operationId: getApiV1ProductsById
      description: One product (accepts a Product id or a GlobalProduct id).
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/Product'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      tags:
      - Products & Catalog
      summary: Update one of the clinic's OWN products
      operationId: putApiV1ProductsById
      description: Update one of the clinic's OWN products.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
            example:
              description: Updated copy
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/Product'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/brand/product-catalog:
    get:
      tags:
      - Products & Catalog
      summary: Alias of /catalog — the brand's fee-adjusted product catalog
      operationId: getApiV1BrandProductcatalog
      description: Alias of /catalog — the brand's fee-adjusted product catalog.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogProduct'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/products-management/{id}:
    get:
      tags:
      - Products & Catalog
      summary: Alias of GET /products/:id — read one of the clinic's own products
      operationId: getApiV1ProductsmanagementById
      description: 'Alias of GET /products/:id. Accepts either a Product id or a GlobalProduct id (resolved to the primary pharmacy''s Product, matching the admin editor). Ownership-gated: a product owned by another brand returns 404. No patient PHI. Read scope.'
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      tags:
      - Products & Catalog
      summary: Alias of PUT /products/:id — update one of the clinic's own products
      operationId: putApiV1ProductsmanagementById
      description: Alias of PUT /products/:id — update one of the clinic's own products.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
            example:
              description: Updated copy
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/Product'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/tenant-products:
    get:
      tags:
      - Products & Catalog
      summary: The clinic's own tenant-product offerings + facilitation fees
      operationId: getApiV1Tenantproducts
      description: The clinic's own tenant-product offerings + facilitation fees.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/global-products/discontinued-in-use:
    get:
      tags:
      - Products & Catalog
      summary: Discontinued global SKUs still referenced by THIS clinic's programs
      operationId: getApiV1GlobalproductsDiscontinuedinuse
      description: Discontinued global SKUs still referenced by THIS clinic's programs.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/tenant-products/update:
    post:
      tags:
      - Products & Catalog
      summary: Set the price of one tenant product (creates a real Stripe price)
      operationId: postApiV1TenantproductsUpdate
      description: Set the price of one tenant product (creates a real Stripe price).
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tenantProductId:
                  type: string
                price:
                  type: integer
            example:
              tenantProductId: <tenant-product-uuid>
              price: 99
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/tenant-products/update-selection:
    post:
      tags:
      - Products & Catalog
      summary: Update the clinic's selected tenant products (enforces plan limits + billing…
      operationId: postApiV1TenantproductsUpdateselection
      description: Update the clinic's selected tenant products (enforces plan limits + billing caps).
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                products:
                  type: array
                  items:
                    type: object
                    properties:
                      productId:
                        type: string
                      questionnaireId:
                        type: string
            example:
              products:
              - productId: <product-uuid>
                questionnaireId: <questionnaire-uuid>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/global-products/{id}/upload-image:
    post:
      tags:
      - Products & Catalog
      summary: Upload a brand-scoped image override for a global product (multipart, field…
      operationId: postApiV1GlobalproductsByIdUploadimage
      description: Upload a brand-scoped image override for a global product (multipart, field `image`; never mutates the shared product).
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                image:
                  type: string
                  format: binary
                  description: Upload file field
              required:
              - image
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/global-form-structures:
    get:
      tags:
      - Products & Catalog
      summary: Shared FUSE global form-builder structure catalog (no clinic data / no PHI)
      operationId: getApiV1Globalformstructures
      description: Shared FUSE global form-builder structure catalog (no clinic data / no PHI).
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/products-management:
    get:
      tags:
      - Products & Catalog
      summary: List the brand's products (product-management view)
      operationId: getApiV1Productsmanagement
      description: The brand's product-management list — its own custom products plus the shared platform SKUs (scoped via the key clinic's brand owner). Same scope the FUSE-hosted admin product list shows. No patient PHI. Read scope.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
          minimum: 1
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: category
        in: query
        required: false
        schema:
          type: string
      - name: categories
        in: query
        required: false
        schema:
          type: string
          description: Comma-separated list.
      - name: isActive
        in: query
        required: false
        schema:
          type: boolean
      - name: pharmacyProvider
        in: query
        required: false
        schema:
          type: string
      - name: isAutoImported
        in: query
        required: false
        schema:
          type: boolean
      - name: hasMdiOffering
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      products:
                        type: array
                        items:
                          type: object
                      pagination:
                        type: object
                        properties:
                          page:
                            type: integer
                          limit:
                            type: integer
                          total:
                            type: integer
                          totalPages:
                            type: integer
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Forbidden:
      description: Authenticated but not permitted (insufficient scope, wrong role, or FUSE feature not enabled)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found (or not owned by the key's clinic)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    BadRequest:
      description: Bad request / business-rule failure (may include a `code`)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, invalid, inactive, or expired API key (or JWT)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      description: 'Failure shape. NOTE: most modules use `message`; programs endpoints use `error`. Read both. Some errors include a machine-readable `code` and/or a `data` payload.'
      type: object
      properties:
        success:
          type: boolean
          enum:
          - false
        message:
          type: string
        error:
          type: string
        code:
          type: string
        data: {}
    Product:
      description: Full management view (serializeProduct) — all Product columns plus derived fields.
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        slug:
          type: string
        description:
          type:
          - string
          - 'null'
        category:
          type:
          - string
          - 'null'
        categories:
          type: array
          items:
            type: string
        isActive:
          type: boolean
        pharmacyProvider:
          type:
          - string
          - 'null'
        pharmacyPrice:
          type: number
        pharmacyProductId:
          type:
          - string
          - 'null'
        brandName:
          type:
          - string
          - 'null'
        imageUrl:
          type:
          - string
          - 'null'
        pharmacyCoverages:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              customName:
                type:
                - string
                - 'null'
              pharmacy:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  slug:
                    type: string
      additionalProperties: true
    CatalogProduct:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        slug:
          type: string
        categories:
          type: array
          items:
            type: string
        imageUrl:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        requiresCooler:
          type: boolean
        pharmacyPrice:
          type: number
        facilitationFee:
          type: number
        price:
          type: number
        pharmacyName:
          type:
          - string
          - 'null'
        pharmacyRole:
          type:
          - string
          - 'null'
          enum:
          - primary
          - secondary
          - fallback
          - null
        programs:
          description: The brand's programs that carry this product. Empty when it is in none of them yet.
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Clinic-scoped API key. Keep server-side; never expose in a browser or app bundle.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: FUSE brand-admin JWT (from POST /auth/signin). Used ONLY by the key-management endpoints — the external /api/v1 surface never accepts JWTs, and API keys never work on key management.