Walmart On-request Report Management — On-Request Report

naftiko: 1.0.0-alpha2
info:
  label: Walmart On-request Report Management — On-Request Report
  description: 'Walmart On-request Report Management — On-Request Report. 4 operations. Lead operation: Walmart Download Report
    Url. Self-contained Naftiko capability covering one Walmart business surface.'
  tags:
  - Walmart
  - On-Request Report
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WALMART_API_KEY: WALMART_API_KEY
capability:
  consumes:
  - type: http
    namespace: marketplace-on-request-reports-on-request-report
    baseUri: https://marketplace.walmartapis.com
    description: Walmart On-request Report Management — On-Request Report business capability. Self-contained, no shared references.
    resources:
    - name: v3-reports-downloadReport
      path: /v3/reports/downloadReport
      operations:
      - name: downloadreport
        method: GET
        description: Walmart Download Report Url
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: requestId
          in: query
          type: string
          description: Automated ID generated by system that uniquely identifies the report request.
          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: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
    - name: v3-reports-reportRequests
      path: /v3/reports/reportRequests
      operations:
      - name: getrequestsstatus
        method: GET
        description: Walmart Get All Report Requests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: reportType
          in: query
          type: string
          description: Type of report for which the request is created. Example, ITEM for Item Report.
          required: true
        - name: reportVersion
          in: query
          type: string
          description: Version of report for which the request is created. Example, v1.
        - name: requestStatus
          in: query
          type: string
          description: Status of report request. Possible values are RECEIVED, INPROGRESS, READY, ERROR.
        - name: requestSubmissionStartDate
          in: query
          type: string
          description: 'Report request submittal start date for range of reports requested, in format: YYYY-MM-DDTHH:mm:ssZ'
        - name: requestSubmissionEndDate
          in: query
          type: string
          description: Report request submittal end date for range of reports requested, in format YYYY-MM-DDTHH:mm:ssZ
        - 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: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
      - name: generatereport
        method: POST
        description: Walmart Create Report Request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: reportType
          in: query
          type: string
          description: Specifies the report type for the request. For example, reportType=ITEM creates an Item Report.
          required: true
        - name: reportVersion
          in: query
          type: string
          description: 'Version of report for which the request is created. Supported versions for each report type are currently
            ''reportVersion=v1'' for the following reportType(s): IN'
          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: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
        - name: Content-Type
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v3-reports-reportRequests-requestId
      path: /v3/reports/reportRequests/{requestId}
      operations:
      - name: getsinglerequeststatus
        method: GET
        description: Walmart Report Request Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: requestId
          in: path
          type: string
          description: Automated ID generated by system that uniquely identifies the report request.
          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: Accept
          in: header
          type: string
          description: 'Only supported Media Type : application/json'
          required: true
  exposes:
  - type: rest
    namespace: marketplace-on-request-reports-on-request-report-rest
    port: 8080
    description: REST adapter for Walmart On-request Report Management — On-Request Report. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v3/reports/downloadreport
      name: v3-reports-downloadreport
      description: REST surface for v3-reports-downloadReport.
      operations:
      - method: GET
        name: downloadreport
        description: Walmart Download Report Url
        call: marketplace-on-request-reports-on-request-report.downloadreport
        with:
          requestId: rest.requestId
          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
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/reports/reportrequests
      name: v3-reports-reportrequests
      description: REST surface for v3-reports-reportRequests.
      operations:
      - method: GET
        name: getrequestsstatus
        description: Walmart Get All Report Requests
        call: marketplace-on-request-reports-on-request-report.getrequestsstatus
        with:
          reportType: rest.reportType
          reportVersion: rest.reportVersion
          requestStatus: rest.requestStatus
          requestSubmissionStartDate: rest.requestSubmissionStartDate
          requestSubmissionEndDate: rest.requestSubmissionEndDate
          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
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: generatereport
        description: Walmart Create Report Request
        call: marketplace-on-request-reports-on-request-report.generatereport
        with:
          reportType: rest.reportType
          reportVersion: rest.reportVersion
          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
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/reports/reportrequests/{requestid}
      name: v3-reports-reportrequests-requestid
      description: REST surface for v3-reports-reportRequests-requestId.
      operations:
      - method: GET
        name: getsinglerequeststatus
        description: Walmart Report Request Status
        call: marketplace-on-request-reports-on-request-report.getsinglerequeststatus
        with:
          requestId: rest.requestId
          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
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketplace-on-request-reports-on-request-report-mcp
    port: 9090
    transport: http
    description: MCP adapter for Walmart On-request Report Management — On-Request Report. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: walmart-download-report-url
      description: Walmart Download Report Url
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-on-request-reports-on-request-report.downloadreport
      with:
        requestId: tools.requestId
        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
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-get-all-report-requests
      description: Walmart Get All Report Requests
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-on-request-reports-on-request-report.getrequestsstatus
      with:
        reportType: tools.reportType
        reportVersion: tools.reportVersion
        requestStatus: tools.requestStatus
        requestSubmissionStartDate: tools.requestSubmissionStartDate
        requestSubmissionEndDate: tools.requestSubmissionEndDate
        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
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-create-report-request
      description: Walmart Create Report Request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketplace-on-request-reports-on-request-report.generatereport
      with:
        reportType: tools.reportType
        reportVersion: tools.reportVersion
        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
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-report-request-status
      description: Walmart Report Request Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketplace-on-request-reports-on-request-report.getsinglerequeststatus
      with:
        requestId: tools.requestId
        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
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.