UNFI Supplier and Data API — Insights

naftiko: 1.0.0-alpha2
info:
  label: UNFI Supplier and Data API — Insights
  description: 'UNFI Supplier and Data API — Insights. 3 operations. Lead operation: Get Fill Rate Data. Self-contained Naftiko
    capability covering one United Natural Foods business surface.'
  tags:
  - United Natural Foods
  - Insights
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNITED_NATURAL_FOODS_API_KEY: UNITED_NATURAL_FOODS_API_KEY
capability:
  consumes:
  - type: http
    namespace: unfi-supplier-insights
    baseUri: https://api.unfi.com/v1
    description: UNFI Supplier and Data API — Insights business capability. Self-contained, no shared references.
    resources:
    - name: insights-fill-rates
      path: /insights/fill-rates
      operations:
      - name: getfillrates
        method: GET
        description: Get Fill Rate Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: string
          required: true
        - name: endDate
          in: query
          type: string
          required: true
        - name: productId
          in: query
          type: string
          description: Filter by specific product
    - name: insights-inventory
      path: /insights/inventory
      operations:
      - name: getinventoryinsights
        method: GET
        description: Get Inventory Insights
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: warehouseId
          in: query
          type: string
          description: Filter by specific UNFI warehouse
        - name: asOf
          in: query
          type: string
          description: Inventory snapshot date
    - name: insights-sales
      path: /insights/sales
      operations:
      - name: getsalesinsights
        method: GET
        description: Get Sales Insights
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: string
          description: Start date for insights query
          required: true
        - name: endDate
          in: query
          type: string
          description: End date for insights query
          required: true
        - name: granularity
          in: query
          type: string
          description: Data aggregation granularity
        - name: region
          in: query
          type: string
          description: Distribution region filter
    authentication:
      type: apikey
      key: X-API-Key
      value: '{{env.UNITED_NATURAL_FOODS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: unfi-supplier-insights-rest
    port: 8080
    description: REST adapter for UNFI Supplier and Data API — Insights. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/insights/fill-rates
      name: insights-fill-rates
      description: REST surface for insights-fill-rates.
      operations:
      - method: GET
        name: getfillrates
        description: Get Fill Rate Data
        call: unfi-supplier-insights.getfillrates
        with:
          startDate: rest.startDate
          endDate: rest.endDate
          productId: rest.productId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/insights/inventory
      name: insights-inventory
      description: REST surface for insights-inventory.
      operations:
      - method: GET
        name: getinventoryinsights
        description: Get Inventory Insights
        call: unfi-supplier-insights.getinventoryinsights
        with:
          warehouseId: rest.warehouseId
          asOf: rest.asOf
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/insights/sales
      name: insights-sales
      description: REST surface for insights-sales.
      operations:
      - method: GET
        name: getsalesinsights
        description: Get Sales Insights
        call: unfi-supplier-insights.getsalesinsights
        with:
          startDate: rest.startDate
          endDate: rest.endDate
          granularity: rest.granularity
          region: rest.region
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: unfi-supplier-insights-mcp
    port: 9090
    transport: http
    description: MCP adapter for UNFI Supplier and Data API — Insights. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-fill-rate-data
      description: Get Fill Rate Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unfi-supplier-insights.getfillrates
      with:
        startDate: tools.startDate
        endDate: tools.endDate
        productId: tools.productId
      outputParameters:
      - type: object
        mapping: $.
    - name: get-inventory-insights
      description: Get Inventory Insights
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unfi-supplier-insights.getinventoryinsights
      with:
        warehouseId: tools.warehouseId
        asOf: tools.asOf
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sales-insights
      description: Get Sales Insights
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unfi-supplier-insights.getsalesinsights
      with:
        startDate: tools.startDate
        endDate: tools.endDate
        granularity: tools.granularity
        region: tools.region
      outputParameters:
      - type: object
        mapping: $.