Walmart Insights Management — Insight

naftiko: 1.0.0-alpha2
info:
  label: Walmart Insights Management — Insight
  description: 'Walmart Insights Management — Insight. 7 operations. Lead operation: Walmart Item Count With Listing Quality
    Issues. Self-contained Naftiko capability covering one Walmart business surface.'
  tags:
  - Walmart
  - Insight
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WALMART_API_KEY: WALMART_API_KEY
capability:
  consumes:
  - type: http
    namespace: marketplace-insights-insight
    baseUri: https://marketplace.walmartapis.com
    description: Walmart Insights Management — Insight business capability. Self-contained, no shared references.
    resources:
    - name: v3-insights-items-listingQuality-count
      path: /v3/insights/items/listingQuality/count
      operations:
      - name: getcategorieslist
        method: GET
        description: Walmart Item Count With Listing Quality Issues
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: viewTrendingItems
          in: query
          type: boolean
          description: Specify whether or not to include seller's items that are trending in the Listing Quality Score.
        - name: wfsFlag
          in: query
          type: boolean
          description: Specify whether or not to include WFS-eligible items in the overall Listing Quality Score.
        - name: hasIssue
          in: query
          type: integer
          description: Specify whether or not to include items that have issues in the Listing Quality Score.
        - name: type
          in: query
          type: string
          description: Specify whether to get item count by brand or category. Category is the default value when no type
            is specified.
        - name: limit
          in: query
          type: integer
          description: Specify number of items to return. The value is defaulted to 100 and the maximum value is 1000.
        - name: offset
          in: query
          type: integer
          description: Specify the offset of item list to be returned.
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
    - name: v3-insights-items-listingQuality-items
      path: /v3/insights/items/listingQuality/items
      operations:
      - name: itemsdetailsforlisting
        method: POST
        description: Walmart Item Listing Quality Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: string
          description: Specify number of items to return. If no limit is specified, API returns 200 items by default.
        - name: nextCursor
          in: query
          type: string
          description: Specify pagination for long list of items.
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v3-insights-items-listingQuality-score
      path: /v3/insights/items/listingQuality/score
      operations:
      - name: getlistingqualityscore
        method: GET
        description: Walmart Seller Listing Quality Score
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: viewTrendingItems
          in: query
          type: boolean
          description: Specify whether or not to include seller's items that are trending in the Listing Quality Score.
        - name: wfsFlag
          in: query
          type: string
          description: Specify whether or not to include WFS-eligible items in the overall Listing Quality Score.
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
    - name: v3-insights-items-trending
      path: /v3/insights/items/trending
      operations:
      - name: gettrendingresult
        method: GET
        description: Walmart Top Trending Items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: departmentId
          in: query
          type: string
          description: departmentId
          required: true
        - name: categoryId
          in: query
          type: string
          description: categoryId
        - name: limit
          in: query
          type: string
          description: The number of items to be returned.
        - name: offset
          in: query
          type: string
          description: The object response to start with, where 0 is the first entity that can be requested.
        - name: timeFrame
          in: query
          type: string
          description: Returns all trending items for the given time frame in days
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
    - name: v3-insights-items-unpublished-counts
      path: /v3/insights/items/unpublished/counts
      operations:
      - name: getunpublisheditemcount
        method: GET
        description: Walmart Unpublished Item Counts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fromDate
          in: query
          type: string
          description: Returns all unpublished items count with reason codes since the given date
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
    - name: v3-insights-items-unpublished-items
      path: /v3/insights/items/unpublished/items
      operations:
      - name: getunpublisheditems
        method: GET
        description: Walmart Unpublished Items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unpublishedReasonCode
          in: query
          type: string
          description: Unpublished reason code
        - name: fromDate
          in: query
          type: string
          description: Returns all unpublished items since the given date
          required: true
        - name: limit
          in: query
          type: string
          description: The number of items to be returned.
        - name: offerLifecycleStatus
          in: query
          type: string
          description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples
            of allowed values are ACTIVE , ARCHIVED, RETIRED.
        - name: marketTrending
          in: query
          type: string
          description: Filter the item list to return only items that are trending on Walmart.com
        - name: itemsWithInventory
          in: query
          type: string
          description: Filter the item list to return only items that have inventory
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
    - name: v3-insights-prosellerbadge
      path: /v3/insights/prosellerbadge
      operations:
      - name: getprosellerbadgeinfo
        method: GET
        description: Walmart Pro Seller Badge Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: The access token retrieved in the Token API call
          required: true
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during
            onboarding
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: A unique ID which identifies each API call and used to track and debug issues; use a random generated
            GUID for this ID
          required: true
        - name: WM_SVC.NAME
          in: header
          type: string
          description: Walmart Service Name
          required: true
  exposes:
  - type: rest
    namespace: marketplace-insights-insight-rest
    port: 8080
    description: REST adapter for Walmart Insights Management — Insight. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v3/insights/items/listingquality/count
      name: v3-insights-items-listingquality-count
      description: REST surface for v3-insights-items-listingQuality-count.
      operations:
      - method: GET
        name: getcategorieslist
        description: Walmart Item Count With Listing Quality Issues
        call: marketplace-insights-insight.getcategorieslist
        with:
          viewTrendingItems: rest.viewTrendingItems
          wfsFlag: rest.wfsFlag
          hasIssue: rest.hasIssue
          type: rest.type
          limit: rest.limit
          offset: rest.offset
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/insights/items/listingquality/items
      name: v3-insights-items-listingquality-items
      description: REST surface for v3-insights-items-listingQuality-items.
      operations:
      - method: POST
        name: itemsdetailsforlisting
        description: Walmart Item Listing Quality Details
        call: marketplace-insights-insight.itemsdetailsforlisting
        with:
          limit: rest.limit
          nextCursor: rest.nextCursor
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/insights/items/listingquality/score
      name: v3-insights-items-listingquality-score
      description: REST surface for v3-insights-items-listingQuality-score.
      operations:
      - method: GET
        name: getlistingqualityscore
        description: Walmart Seller Listing Quality Score
        call: marketplace-insights-insight.getlistingqualityscore
        with:
          viewTrendingItems: rest.viewTrendingItems
          wfsFlag: rest.wfsFlag
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/insights/items/trending
      name: v3-insights-items-trending
      description: REST surface for v3-insights-items-trending.
      operations:
      - method: GET
        name: gettrendingresult
        description: Walmart Top Trending Items
        call: marketplace-insights-insight.gettrendingresult
        with:
          departmentId: rest.departmentId
          categoryId: rest.categoryId
          limit: rest.limit
          offset: rest.offset
          timeFrame: rest.timeFrame
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/insights/items/unpublished/counts
      name: v3-insights-items-unpublished-counts
      description: REST surface for v3-insights-items-unpublished-counts.
      operations:
      - method: GET
        name: getunpublisheditemcount
        description: Walmart Unpublished Item Counts
        call: marketplace-insights-insight.getunpublisheditemcount
        with:
          fromDate: rest.fromDate
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/insights/items/unpublished/items
      name: v3-insights-items-unpublished-items
      description: REST surface for v3-insights-items-unpublished-items.
      operations:
      - method: GET
        name: getunpublisheditems
        description: Walmart Unpublished Items
        call: marketplace-insights-insight.getunpublisheditems
        with:
          unpublishedReasonCode: rest.unpublishedReasonCode
          fromDate: rest.fromDate
          limit: rest.limit
          offerLifecycleStatus: rest.offerLifecycleStatus
          marketTrending: rest.marketTrending
          itemsWithInventory: rest.itemsWithInventory
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/insights/prosellerbadge
      name: v3-insights-prosellerbadge
      description: REST surface for v3-insights-prosellerbadge.
      operations:
      - method: GET
        name: getprosellerbadgeinfo
        description: Walmart Pro Seller Badge Status
        call: marketplace-insights-insight.getprosellerbadgeinfo
        with:
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SVC.NAME: rest.WM_SVC.NAME
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketplace-insights-insight-mcp
    port: 9090
    transport: http
    description: MCP adapter for Walmart Insights Management — Insight. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: walmart-item-count-listing-quality
      description: Walmart Item Count With Listing Quality Issues
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-insights-insight.getcategorieslist
      with:
        viewTrendingItems: tools.viewTrendingItems
        wfsFlag: tools.wfsFlag
        hasIssue: tools.hasIssue
        type: tools.type
        limit: tools.limit
        offset: tools.offset
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-item-listing-quality-details
      description: Walmart Item Listing Quality Details
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketplace-insights-insight.itemsdetailsforlisting
      with:
        limit: tools.limit
        nextCursor: tools.nextCursor
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-seller-listing-quality-score
      description: Walmart Seller Listing Quality Score
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-insights-insight.getlistingqualityscore
      with:
        viewTrendingItems: tools.viewTrendingItems
        wfsFlag: tools.wfsFlag
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-top-trending-items
      description: Walmart Top Trending Items
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-insights-insight.gettrendingresult
      with:
        departmentId: tools.departmentId
        categoryId: tools.categoryId
        limit: tools.limit
        offset: tools.offset
        timeFrame: tools.timeFrame
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-unpublished-item-counts
      description: Walmart Unpublished Item Counts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-insights-insight.getunpublisheditemcount
      with:
        fromDate: tools.fromDate
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-unpublished-items
      description: Walmart Unpublished Items
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-insights-insight.getunpublisheditems
      with:
        unpublishedReasonCode: tools.unpublishedReasonCode
        fromDate: tools.fromDate
        limit: tools.limit
        offerLifecycleStatus: tools.offerLifecycleStatus
        marketTrending: tools.marketTrending
        itemsWithInventory: tools.itemsWithInventory
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-pro-seller-badge-status
      description: Walmart Pro Seller Badge Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-insights-insight.getprosellerbadgeinfo
      with:
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SVC.NAME: tools.WM_SVC.NAME
      outputParameters:
      - type: object
        mapping: $.