eBay Feed API — Schedule

naftiko: 1.0.0-alpha2
info:
  label: eBay Feed API — Schedule
  description: 'eBay Feed API — Schedule. 8 operations. Lead operation: Schedule. Self-contained Naftiko capability covering
    one Ebay business surface.'
  tags:
  - Ebay
  - Schedule
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    EBAY_API_KEY: EBAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: feed-schedule
    baseUri: https://api.ebay.com{basePath}
    description: eBay Feed API — Schedule business capability. Self-contained, no shared references.
    resources:
    - name: schedule
      path: /schedule
      operations:
      - name: getschedules
        method: GET
        description: This method retrieves an array containing the details and status of all schedules based on the specified
          <strong>feed_type</strong>. Use this method to find a schedule if you do not know the <strong>schedule_id</strong>.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: feed_type
          in: query
          type: string
          description: The feed type associated with the schedules being retrieved.<br><br><span class="tablenote"><b>Note:</b>
            Schedules are currently only available for <code>LMS_OR
          required: true
        - name: limit
          in: query
          type: string
          description: 'The maximum number of schedules that can be returned on each page of the paginated response. Use this
            parameter in conjunction with the <strong>offset</strong> '
        - name: offset
          in: query
          type: string
          description: The number of schedules to skip in the result set before returning the first schedule in the paginated
            response. <p>Combine <strong>offset</strong> with the <st
      - name: createschedule
        method: POST
        description: This method creates a schedule, which is a subscription to the specified schedule template. A schedule
          periodically generates a report for the <strong>feedType</strong> specified by the template. Specify the same <strong>feedType</strong>
          a
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: schedule-schedule_id
      path: /schedule/{schedule_id}
      operations:
      - name: getschedule
        method: GET
        description: This method retrieves schedule details and status of the specified schedule. Specify the schedule to
          retrieve using the <strong>schedule_id</strong>. Use the <strong>getSchedules</strong> method to find a schedule
          if you do not know the <st
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: schedule_id
          in: path
          type: string
          description: This path parameter is the unique identifier of the schedule for which to retrieve details.<br><br>
            Use the <a href="/api-docs/sell/feed/resources/schedule/meth
          required: true
      - name: updateschedule
        method: PUT
        description: This method updates an existing schedule. Specify the schedule to update using the <strong>schedule_id</strong>
          path parameter. If the schedule template has changed after the schedule was created or updated, the input will be
          validated usin
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: schedule_id
          in: path
          type: string
          description: This path parameter is the unique identifier of the schedule being updated. <br><br> Use the <a href="/api-docs/sell/feed/resources/schedule/methods/getSchedule
          required: true
        - name: Content-Type
          in: header
          type: string
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteschedule
        method: DELETE
        description: This method deletes an existing schedule. Specify the schedule to delete using the <strong>schedule_id</strong>
          path parameter.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: schedule_id
          in: path
          type: string
          description: This path parameter is the unique identifier of the schedule being deleted.<br><br>Use the <a href="/api-docs/sell/feed/resources/schedule/methods/getSchedules"
          required: true
    - name: schedule-schedule_id-download_result_file
      path: /schedule/{schedule_id}/download_result_file
      operations:
      - name: getlatestresultfile
        method: GET
        description: 'This method downloads the latest Order Report generated by the schedule. The response of this call is
          a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz). Specify
          the <strong>schedul'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: schedule_id
          in: path
          type: string
          description: This path parameter is the unique identifier of the schedule for which to retrieve the latest Order
            Report. <br><br> Use the <a href="/api-docs/sell/feed/resour
          required: true
    - name: schedule_template
      path: /schedule_template
      operations:
      - name: getscheduletemplates
        method: GET
        description: This method retrieves an array containing the details and status of all schedule templates based on the
          specified <strong>feed_type</strong>. Use this method to find a schedule template if you do not know the <strong>schedule_template_id</s
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: feed_type
          in: query
          type: string
          description: The feed type of the schedule templates to retrieve. <br><br><span class="tablenote"><b>Note:</b> Schedules
            are currently only available for <code>LMS_ORDER_REP
          required: true
        - name: limit
          in: query
          type: string
          description: The maximum number of schedule templates that can be returned on each page of the paginated response.
            Use this parameter in conjunction with the <strong>offset<
        - name: offset
          in: query
          type: string
          description: The number of schedule templates to skip in the result set before returning the first template in the
            paginated response. <p>Combine <strong>offset</strong> wit
    - name: schedule_template-schedule_template_id
      path: /schedule_template/{schedule_template_id}
      operations:
      - name: getscheduletemplate
        method: GET
        description: This method retrieves the details of the specified template. Specify the template to retrieve using the
          <strong>schedule_template_id</strong> path parameter. Use the <strong>getScheduleTemplates</strong> method to find
          a schedule template i
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: schedule_template_id
          in: path
          type: string
          description: This path parameter is the unique identifier of the schedule template being retrieved.<br><br>Use the
            <a href="/api-docs/sell/feed/resources/schedule/methods/ge
          required: true
    authentication:
      type: bearer
      token: '{{env.EBAY_API_KEY}}'
  exposes:
  - type: rest
    namespace: feed-schedule-rest
    port: 8080
    description: REST adapter for eBay Feed API — Schedule. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/schedule
      name: schedule
      description: REST surface for schedule.
      operations:
      - method: GET
        name: getschedules
        description: This method retrieves an array containing the details and status of all schedules based on the specified
          <strong>feed_type</strong>. Use this method to find a schedule if you do not know the <strong>schedule_id</strong>.
        call: feed-schedule.getschedules
        with:
          feed_type: rest.feed_type
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createschedule
        description: This method creates a schedule, which is a subscription to the specified schedule template. A schedule
          periodically generates a report for the <strong>feedType</strong> specified by the template. Specify the same <strong>feedType</strong>
          a
        call: feed-schedule.createschedule
        with:
          Content-Type: rest.Content-Type
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/schedule/{schedule-id}
      name: schedule-schedule-id
      description: REST surface for schedule-schedule_id.
      operations:
      - method: GET
        name: getschedule
        description: This method retrieves schedule details and status of the specified schedule. Specify the schedule to
          retrieve using the <strong>schedule_id</strong>. Use the <strong>getSchedules</strong> method to find a schedule
          if you do not know the <st
        call: feed-schedule.getschedule
        with:
          schedule_id: rest.schedule_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateschedule
        description: This method updates an existing schedule. Specify the schedule to update using the <strong>schedule_id</strong>
          path parameter. If the schedule template has changed after the schedule was created or updated, the input will be
          validated usin
        call: feed-schedule.updateschedule
        with:
          schedule_id: rest.schedule_id
          Content-Type: rest.Content-Type
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteschedule
        description: This method deletes an existing schedule. Specify the schedule to delete using the <strong>schedule_id</strong>
          path parameter.
        call: feed-schedule.deleteschedule
        with:
          schedule_id: rest.schedule_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/schedule/{schedule-id}/download-result-file
      name: schedule-schedule-id-download-result-file
      description: REST surface for schedule-schedule_id-download_result_file.
      operations:
      - method: GET
        name: getlatestresultfile
        description: 'This method downloads the latest Order Report generated by the schedule. The response of this call is
          a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz). Specify
          the <strong>schedul'
        call: feed-schedule.getlatestresultfile
        with:
          schedule_id: rest.schedule_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/schedule-template
      name: schedule-template
      description: REST surface for schedule_template.
      operations:
      - method: GET
        name: getscheduletemplates
        description: This method retrieves an array containing the details and status of all schedule templates based on the
          specified <strong>feed_type</strong>. Use this method to find a schedule template if you do not know the <strong>schedule_template_id</s
        call: feed-schedule.getscheduletemplates
        with:
          feed_type: rest.feed_type
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/schedule-template/{schedule-template-id}
      name: schedule-template-schedule-template-id
      description: REST surface for schedule_template-schedule_template_id.
      operations:
      - method: GET
        name: getscheduletemplate
        description: This method retrieves the details of the specified template. Specify the template to retrieve using the
          <strong>schedule_template_id</strong> path parameter. Use the <strong>getScheduleTemplates</strong> method to find
          a schedule template i
        call: feed-schedule.getscheduletemplate
        with:
          schedule_template_id: rest.schedule_template_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: feed-schedule-mcp
    port: 9090
    transport: http
    description: MCP adapter for eBay Feed API — Schedule. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: this-method-retrieves-array-containing
      description: This method retrieves an array containing the details and status of all schedules based on the specified
        <strong>feed_type</strong>. Use this method to find a schedule if you do not know the <strong>schedule_id</strong>.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: feed-schedule.getschedules
      with:
        feed_type: tools.feed_type
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: this-method-creates-schedule-which
      description: This method creates a schedule, which is a subscription to the specified schedule template. A schedule
        periodically generates a report for the <strong>feedType</strong> specified by the template. Specify the same <strong>feedType</strong>
        a
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: feed-schedule.createschedule
      with:
        Content-Type: tools.Content-Type
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: this-method-retrieves-schedule-details
      description: This method retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve
        using the <strong>schedule_id</strong>. Use the <strong>getSchedules</strong> method to find a schedule if you do
        not know the <st
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: feed-schedule.getschedule
      with:
        schedule_id: tools.schedule_id
      outputParameters:
      - type: object
        mapping: $.
    - name: this-method-updates-existing-schedule
      description: This method updates an existing schedule. Specify the schedule to update using the <strong>schedule_id</strong>
        path parameter. If the schedule template has changed after the schedule was created or updated, the input will be
        validated usin
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: feed-schedule.updateschedule
      with:
        schedule_id: tools.schedule_id
        Content-Type: tools.Content-Type
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: this-method-deletes-existing-schedule
      description: This method deletes an existing schedule. Specify the schedule to delete using the <strong>schedule_id</strong>
        path parameter.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: feed-schedule.deleteschedule
      with:
        schedule_id: tools.schedule_id
      outputParameters:
      - type: object
        mapping: $.
    - name: this-method-downloads-latest-order
      description: 'This method downloads the latest Order Report generated by the schedule. The response of this call is
        a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz). Specify
        the <strong>schedul'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: feed-schedule.getlatestresultfile
      with:
        schedule_id: tools.schedule_id
      outputParameters:
      - type: object
        mapping: $.
    - name: this-method-retrieves-array-containing-2
      description: This method retrieves an array containing the details and status of all schedule templates based on the
        specified <strong>feed_type</strong>. Use this method to find a schedule template if you do not know the <strong>schedule_template_id</s
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: feed-schedule.getscheduletemplates
      with:
        feed_type: tools.feed_type
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: this-method-retrieves-details-specified
      description: This method retrieves the details of the specified template. Specify the template to retrieve using the
        <strong>schedule_template_id</strong> path parameter. Use the <strong>getScheduleTemplates</strong> method to find
        a schedule template i
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: feed-schedule.getscheduletemplate
      with:
        schedule_template_id: tools.schedule_template_id
      outputParameters:
      - type: object
        mapping: $.