Walmart On Request Reports Management — On Request Reports

naftiko: 1.0.0-alpha2
info:
  label: Walmart On Request Reports Management — On Request Reports
  description: 'Walmart On Request Reports Management — On Request Reports. 4 operations. Lead operation: Walmart Download
    Report Url. Self-contained Naftiko capability covering one Walmart business surface.'
  tags:
  - Walmart
  - On Request Reports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WALMART_API_KEY: WALMART_API_KEY
capability:
  consumes:
  - type: http
    namespace: dropship-vendor-on-request-reports-on-request-reports
    baseUri: https://api-gateway.walmart.com
    description: Walmart On Request Reports Management — On Request Reports business capability. Self-contained, no shared
      references.
    resources:
    - name: v3-reports-downloadReport
      path: /v3/reports/downloadReport
      operations:
      - name: downloadreporturl
        method: GET
        description: Walmart Download Report Url
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: requestId
          in: query
          type: string
          description: Specifies the system-generated identifier associated with the report request.
          required: true
        - name: Accept
          in: header
          type: string
          description: Specifies the data type expected in a response sent from the server.
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: Specifies an identifier that tracks the consumer request by channel.
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: Specifies an identifier for each API call and is used to track and debug issues.
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: Specifies the access token retrieved in the <a href="https://developer.walmart.com/api/us/supplier/auth#operation/dsvTokenAPI">Create
            Access Token</a> request.
          required: true
    - name: v3-reports-reportRequests
      path: /v3/reports/reportRequests
      operations:
      - name: createreportrequest
        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. '
          required: true
        - name: reportVersion
          in: query
          type: string
          description: 'Specifies the version of the created report. '
          required: true
        - name: Accept
          in: header
          type: string
          description: Specifies the data type expected in a response sent from the server.
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: Specifies an identifier that tracks the consumer request by channel.
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: Specifies an identifier for each API call and is used to track and debug issues.
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: Specifies the access token retrieved in the <a href="https://developer.walmart.com/api/us/supplier/auth#operation/dsvTokenAPI">Create
            Access Token</a> request.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getallreportrequests
        method: GET
        description: Walmart Retrieve All Report Requests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: reportType
          in: query
          type: string
          description: 'Specifies the report type for the request. '
          required: true
        - name: reportVersion
          in: query
          type: string
          description: 'Specifies the version of the created report. '
        - name: requestStatus
          in: query
          type: string
          description: 'Specifies the status of the report request. '
        - name: requestSubmissionStartDate
          in: query
          type: string
          description: Specifies the report submittal start date-timestamp for the range of reports request, in ISO 8601 format.
        - name: requestSubmissionEndDate
          in: query
          type: string
          description: Specifies the report submittal end date-timestamp for the range of reports request, in ISO 8601 format.
        - name: Accept
          in: header
          type: string
          description: Specifies the data type expected in a response sent from the server.
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: Specifies an identifier that tracks the consumer request by channel.
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: Specifies an identifier for each API call and is used to track and debug issues.
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: Specifies the access token retrieved in the <a href="https://developer.walmart.com/api/us/supplier/auth#operation/dsvTokenAPI">Create
            Access Token</a> request.
          required: true
    - name: v3-reports-reportRequests-requestId
      path: /v3/reports/reportRequests/{requestId}
      operations:
      - name: retrievereportrequeststatus
        method: GET
        description: Walmart Retrieve Details on Single Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: requestId
          in: path
          type: string
          description: Specifies the system-generated identifier associated with the report request.
          required: true
        - name: Accept
          in: header
          type: string
          description: Specifies the data type expected in a response sent from the server.
        - name: WM_CONSUMER.CHANNEL.TYPE
          in: header
          type: string
          description: Specifies an identifier that tracks the consumer request by channel.
        - name: WM_QOS.CORRELATION_ID
          in: header
          type: string
          description: Specifies an identifier for each API call and is used to track and debug issues.
          required: true
        - name: WM_SEC.ACCESS_TOKEN
          in: header
          type: string
          description: Specifies the access token retrieved in the <a href="https://developer.walmart.com/api/us/supplier/auth#operation/dsvTokenAPI">Create
            Access Token</a> request.
          required: true
  exposes:
  - type: rest
    namespace: dropship-vendor-on-request-reports-on-request-reports-rest
    port: 8080
    description: REST adapter for Walmart On Request Reports Management — On Request Reports. 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: downloadreporturl
        description: Walmart Download Report Url
        call: dropship-vendor-on-request-reports-on-request-reports.downloadreporturl
        with:
          requestId: rest.requestId
          Accept: rest.Accept
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/reports/reportrequests
      name: v3-reports-reportrequests
      description: REST surface for v3-reports-reportRequests.
      operations:
      - method: POST
        name: createreportrequest
        description: Walmart Create Report Request
        call: dropship-vendor-on-request-reports-on-request-reports.createreportrequest
        with:
          reportType: rest.reportType
          reportVersion: rest.reportVersion
          Accept: rest.Accept
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getallreportrequests
        description: Walmart Retrieve All Report Requests
        call: dropship-vendor-on-request-reports-on-request-reports.getallreportrequests
        with:
          reportType: rest.reportType
          reportVersion: rest.reportVersion
          requestStatus: rest.requestStatus
          requestSubmissionStartDate: rest.requestSubmissionStartDate
          requestSubmissionEndDate: rest.requestSubmissionEndDate
          Accept: rest.Accept
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
        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: retrievereportrequeststatus
        description: Walmart Retrieve Details on Single Report
        call: dropship-vendor-on-request-reports-on-request-reports.retrievereportrequeststatus
        with:
          requestId: rest.requestId
          Accept: rest.Accept
          WM_CONSUMER.CHANNEL.TYPE: rest.WM_CONSUMER.CHANNEL.TYPE
          WM_QOS.CORRELATION_ID: rest.WM_QOS.CORRELATION_ID
          WM_SEC.ACCESS_TOKEN: rest.WM_SEC.ACCESS_TOKEN
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: dropship-vendor-on-request-reports-on-request-reports-mcp
    port: 9090
    transport: http
    description: MCP adapter for Walmart On Request Reports Management — On Request Reports. 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: dropship-vendor-on-request-reports-on-request-reports.downloadreporturl
      with:
        requestId: tools.requestId
        Accept: tools.Accept
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-create-report-request
      description: Walmart Create Report Request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: dropship-vendor-on-request-reports-on-request-reports.createreportrequest
      with:
        reportType: tools.reportType
        reportVersion: tools.reportVersion
        Accept: tools.Accept
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-retrieve-all-report-requests
      description: Walmart Retrieve All Report Requests
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: dropship-vendor-on-request-reports-on-request-reports.getallreportrequests
      with:
        reportType: tools.reportType
        reportVersion: tools.reportVersion
        requestStatus: tools.requestStatus
        requestSubmissionStartDate: tools.requestSubmissionStartDate
        requestSubmissionEndDate: tools.requestSubmissionEndDate
        Accept: tools.Accept
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
      outputParameters:
      - type: object
        mapping: $.
    - name: walmart-retrieve-details-single-report
      description: Walmart Retrieve Details on Single Report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: dropship-vendor-on-request-reports-on-request-reports.retrievereportrequeststatus
      with:
        requestId: tools.requestId
        Accept: tools.Accept
        WM_CONSUMER.CHANNEL.TYPE: tools.WM_CONSUMER.CHANNEL.TYPE
        WM_QOS.CORRELATION_ID: tools.WM_QOS.CORRELATION_ID
        WM_SEC.ACCESS_TOKEN: tools.WM_SEC.ACCESS_TOKEN
      outputParameters:
      - type: object
        mapping: $.