eBay Task API

openapi: 3.2.0
info:
  title: eBay Feed Task API
  description: <p>The <strong>Feed API</strong> lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.</p>
  contact:
    name: eBay Inc,
  license:
    name: eBay API License Agreement
    url: https://go.developer.ebay.com/api-license-agreement
  version: v1.3.1
servers:
- url: https://api.ebay.com{basePath}
  description: Production
  variables:
    basePath:
      default: /sell/feed/v1
tags:
- name: Task
paths:
  /task:
    get:
      tags:
      - Task
      description: 'This method returns the details and status for an array of tasks based on a specified <strong>feed_type</strong> or <strong>schedule_id</strong>. Specifying both <strong>feed_type</strong> and <strong>schedule_id</strong> results in an error. Since schedules are based on feed types, you can specify a schedule (<strong>schedule_id</strong>) that returns the needed <strong>feed_type</strong>.<br /><br />If specifying the <strong>feed_type</strong>, limit which tasks are returned by specifying filters, such as the creation date range or period of time using <strong>look_back_days</strong>. Also, by specifying the <strong>feed_type</strong>, both on-demand and scheduled reports are returned.<br /><br />If specifying a <strong>schedule_id</strong>, the schedule template (that the schedule ID is based on) determines which tasks are returned (see <strong>schedule_id</strong> for additional information). Each <strong>scheduledId</strong> applies to one <strong>feed_type</strong>. '
      operationId: getTasks
      parameters:
      - name: date_range
        in: query
        description: 'Specifies the range of task creation dates used to filter the results. The results are filtered to include only tasks with a creation date that is equal to this date or is within specified range. Only tasks that are less than 90 days can be retrieved. <p> <span class="tablenote"><strong>Note:</strong> Maximum date range window size is 90 days.</span></p> <br /><b>Valid Format (UTC):</b><code>yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ </code><br /><br />For example: Tasks created on September 8, 2019<br /> <code>2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z</code>'
        required: false
        schema:
          type: string
      - name: feed_type
        in: query
        description: 'The feed type associated with the tasks to be returned. Only use a <strong>feedType</strong> that is available for your API: <ul><li>Order Feeds: <code>LMS_ORDER_ACK, LMS_ORDER_REPORT</code></li><li>Inventory Upload Feed Types: See <a href="/api-docs/sell/static/feed/lms-feeds-quick-reference.html#Availabl" target="_blank">Available FeedTypes</a></li></ul>Do not use with the <strong>schedule_id</strong> parameter. Since schedules are based on feed types, you can specify a schedule (<strong>schedule_id</strong>) that returns the needed <strong>feed_type</strong>.'
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: 'The maximum number of tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the <strong>offset</strong> parameter to control the pagination of the output. <p> <span class="tablenote"><strong>Note:</strong> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.</span></p><p>For example, if <strong>offset</strong> is set to 10 and <strong>limit</strong> is set to 10, the call retrieves tasks 11 thru 20 from the result set.</p><p>If this parameter is omitted, the default value is used. <br /><br /><b>Default: </b> 10 <br /><br /><b>Maximum: </b>500'
        required: false
        schema:
          type: string
      - name: look_back_days
        in: query
        description: 'The number of previous days in which to search for tasks. Do not use with the <code>date_range</code> parameter. If both <code>date_range</code> and <code>look_back_days</code> are omitted, this parameter''s default value is used.  <br /><br /><b>Default: </b> 7 <br /><br /><b>Range: </b> 1-90 (inclusive)'
        required: false
        schema:
          type: string
      - name: offset
        in: query
        description: 'The number of tasks to skip in the result set before returning the first task in the paginated response. <p>Combine <strong>offset</strong> with the <strong>limit</strong> query parameter to control the items returned in the response. For example, if you supply an <strong>offset</strong> of <code>0</code> and a <strong>limit</strong> of <code>10</code>, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If <strong>offset</strong> is <code>10</code> and <strong>limit</strong> is <code>20</code>, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned. <br /><br /><b>Default: </b>0'
        required: false
        schema:
          type: string
      - name: schedule_id
        in: query
        description: The unique identifier associated with the tasks being returned. A schedule periodically generates a report for the feed type specified by the schedule template.<br><br><span class="tablenote"><b>Note:</b> Schedules are currently only available for <code>LMS_ORDER_REPORT</code>.</span><br>Do not use with the <strong>feed_type</strong> parameter.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskCollection'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '160004':
                domain: API_FEED
                category: REQUEST
                description: You must submit either a 'feed_type' or 'schedule_id'.
              '160005':
                domain: API_FEED
                category: REQUEST
                description: Both 'feed_type' and 'schedule_id' were provided. Please remove one of them.
              '160006':
                domain: API_FEED
                category: REQUEST
                description: The 'feed_type' {feedTypeValue} is invalid.
              '160007':
                domain: API_FEED
                category: REQUEST
                description: The 'schedule_id' {scheduleID} is invalid.
              '160008':
                domain: API_FEED
                category: REQUEST
                description: Both 'look_back_days' and 'date_range' were provided. Please remove one of them.
              '160009':
                domain: API_FEED
                category: REQUEST
                description: The format of the 'date_range' is invalid. The format for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ.
              '160010':
                domain: API_FEED
                category: REQUEST
                description: The 'date_range' must be less than or equal to 90 days.
              '160011':
                domain: API_FEED
                category: REQUEST
                description: The 'look_back_days' value must be greater than zero and less than or equal to 90.
              '160012':
                domain: API_FEED
                category: REQUEST
                description: The 'limit' value must be greater than zero and less than or equal to 500.
              '160013':
                domain: API_FEED
                category: REQUEST
                description: The 'offset' value cannot be less than zero.
              '160016':
                domain: API_FEED
                category: REQUEST
                description: The 'date_range' value is not valid. Ensure that the beginning of the range is before the end of the range.
              '160029':
                domain: API_FEED
                category: REQUEST
                description: The 'offset' value must be a multiple of the 'limit' value.
        '403':
          description: Forbidden
          x-response-codes:
            errors:
              '160002':
                domain: API_FEED
                category: REQUEST
                description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '160001':
                domain: API_FEED
                category: APPLICATION
                description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.inventory
        - https://api.ebay.com/oauth/api_scope/sell.fulfillment
        - https://api.ebay.com/oauth/api_scope/sell.marketing
        - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
        - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
    post:
      tags:
      - Task
      description: 'This method creates an upload task or a download task without filter criteria. When using this method, specify the <b> feedType</b> and the feed file <b> schemaVersion</b>. The feed type specified sets the task as a download or an upload task.  <p>For details about the upload and download flows, see <a href="/api-docs/sell/static/orders/generating-and-retrieving-order-reports.html">Working with Order Feeds</a> in the Selling Integration Guide.</p><p> <span class="tablenote"><strong>Note:</strong> The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.</span></p><p>The following list contains this method''s authorization scopes and their corresponding feed types:</p><ul><li>https://api.ebay.com/oauth/api_scope/sell.inventory: See <a href="/api-docs/sell/static/feed/lms-feeds-quick-reference.html#Availabl" target="_blank">LMS FeedTypes</a></li><li>https://api.ebay.com/oauth/api_scope/sell.fulfillment: LMS_ORDER_ACK (specify for upload tasks). Also see <a href="/api-docs/sell/static/feed/lms-feeds-quick-reference.html#Availabl" target="_blank">LMS FeedTypes</a></li><li>https://api.ebay.com/oauth/api_scope/sell.marketing: None*</li><li>https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly: None*</li></ul><p>* Reserved for future release</p>'
      operationId: createTask
      parameters:
      - name: X-EBAY-C-MARKETPLACE-ID
        in: header
        description: The ID of the eBay marketplace where the item is hosted. <br><br>For example:<br><br><code>X-EBAY-C-MARKETPLACE-ID:EBAY_US</code><br><br>This identifies the eBay marketplace that applies to this task. See <a href="/api-docs/sell/feed/types/bas:MarketplaceIdEnum">MarketplaceIdEnum</a> for supported values.</p>
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        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, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
        required: true
        schema:
          type: string
      requestBody:
        description: description not needed
        content:
          application/json:
            schema:
              description: description not needed
              $ref: '#/components/schemas/CreateTaskRequest'
        required: true
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '160017':
                domain: API_FEED
                category: REQUEST
                description: The 'feedType' is missing or invalid.
              '160018':
                domain: API_FEED
                category: REQUEST
                description: The 'schemaVersion' is invalid.
              '160027':
                domain: API_FEED
                category: REQUEST
                description: The X-EBAY-C-MARKETPLACE-ID header is missing or invalid.
              '160030':
                domain: API_FEED
                category: REQUEST
                description: This resource is not applicable for the feed type {feedTypeValue}. For more information, see the documentation for this API.
        '403':
          description: Forbidden
          x-response-codes:
            errors:
              '160002':
                domain: API_FEED
                category: REQUEST
                description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
              '160022':
                domain: API_FEED
                category: REQUEST
                description: You are not allowed to access this resource. Contact eBay Developer Technical Support for assistance.
        '409':
          description: Conflict
          x-response-codes:
            errors:
              '160024':
                domain: API_FEED
                category: BUSINESS
                description: You have reached the maximum number of feed tasks that can be queued or processed concurrently. Wait for current tasks to complete before adding tasks. For more information, see the documentation for this API.
              '160025':
                domain: API_FEED
                category: BUSINESS
                description: You have exceeded the maximum number of records or tasks that can be created or processed in the period (hourly or daily). Wait until the present period ends before trying again. Please reference the API documentation for more information.
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '160001':
                domain: API_FEED
                category: APPLICATION
                description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.inventory
        - https://api.ebay.com/oauth/api_scope/sell.fulfillment
        - https://api.ebay.com/oauth/api_scope/sell.marketing
        - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
        - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
  /task/{task_id}/download_input_file:
    get:
      tags:
      - Task
      description: This method downloads the file previously uploaded using <strong>uploadFile</strong>. Specify the task_id from the <strong>uploadFile</strong> call. <p><span class="tablenote"><strong>Note:</strong> With respect to LMS, this method applies to all feed types except <code>LMS_ORDER_REPORT</code> and <code>LMS_ACTIVE_INVENTORY_REPORT</code>. See <a href="/api-docs/sell/static/feed/lms-feeds.html">LMS API Feeds</a> in the Selling Integration Guide.</span></p>
      operationId: getInputFile
      parameters:
      - name: task_id
        in: path
        description: This path parameter is the unique identifier of the task associated with the input file to be downloaded.<br><br>Use the <a href="/api-docs/sell/feed/resources/task/methods/getTasks" target="_blank ">getTasks</a> method to retrieve task IDs.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers:
            content-disposition:
              schema:
                type: string
                description: Returns metadata for the downloaded file.
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/StreamingOutput'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
          x-response-codes:
            errors:
              '160002':
                domain: API_FEED
                category: REQUEST
                description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
        '404':
          description: Not Found
          x-response-codes:
            errors:
              '160003':
                domain: API_FEED
                category: REQUEST
                description: Task {taskID} does not exist.
              '160014':
                domain: API_FEED
                category: REQUEST
                description: No file found for task ID {taskID}.
              '160015':
                domain: API_FEED
                category: REQUEST
                description: 'The ''task_id'' {taskID} is a download task, which in invalid for an input file. '
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '160001':
                domain: API_FEED
                category: APPLICATION
                description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.inventory
        - https://api.ebay.com/oauth/api_scope/sell.fulfillment
        - https://api.ebay.com/oauth/api_scope/sell.marketing
        - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
        - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
  /task/{task_id}/download_result_file:
    get:
      tags:
      - Task
      description: 'This method retrieves the generated file that is associated with the specified task ID. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz). <p>For details about how this method is used, see <a href="/api-docs/sell/static/orders/generating-and-retrieving-order-reports.html">Working with Order Feeds</a> in the Selling Integration Guide. </p><p><span class="tablenote"><strong>Note:</strong> The status of the task to retrieve must be in the COMPLETED or COMPLETED_WITH_ERROR state before this method can retrieve the file. You can use the getTask or getTasks method to retrieve the status of the task.</span></p>'
      operationId: getResultFile
      parameters:
      - name: task_id
        in: path
        description: This path parameter is the unique identifier of the task associated with the file to be downloaded. <br><br>Use the <a href="/api-docs/sell/feed/resources/task/methods/getTasks" target="_blank ">getTasks</a> method to retrieve task IDs.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers:
            content-disposition:
              schema:
                type: string
                description: Returns metadata for the downloaded file.
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/StreamingOutput'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
          x-response-codes:
            errors:
              '160002':
                domain: API_FEED
                category: REQUEST
                description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
        '404':
          description: Not Found
          x-response-codes:
            errors:
              '160003':
                domain: API_FEED
                category: REQUEST
                description: Task {taskID} does not exist.
              '160014':
                domain: API_FEED
                category: REQUEST
                description: No file found for task ID {taskID}.
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '160001':
                domain: API_FEED
                category: APPLICATION
                description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.inventory
        - https://api.ebay.com/oauth/api_scope/sell.fulfillment
        - https://api.ebay.com/oauth/api_scope/sell.marketing
        - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
        - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
  /task/{task_id}:
    get:
      tags:
      - Task
      description: 'This method retrieves the details and status of the specified task. The input is <strong>task_id</strong>. <br /><br />For details of how this method is used, see <a href="/api-docs/sell/static/orders/generating-and-retrieving-order-reports.html">Working with Order Feeds</a> in the Selling Integration Guide. '
      operationId: getTask
      parameters:
      - name: task_id
        in: path
        description: This path parameter is the unique identifier of the task being retrieved.<br><br>Use the <a href="/api-docs/sell/feed/resources/task/methods/getTasks" target="_blank ">getTasks</a> method to retrieve task IDs.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
          x-response-codes:
            errors:
              '160002':
                domain: API_FEED
                category: REQUEST
                description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
        '404':
          description: Not Found
          x-response-codes:
            errors:
              '160003':
                domain: API_FEED
                category: REQUEST
                description: Task {taskID} does not exist.
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '160001':
                domain: API_FEED
                category: APPLICATION
                description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.inventory
        - https://api.ebay.com/oauth/api_scope/sell.fulfillment
        - https://api.ebay.com/oauth/api_scope/sell.marketing
        - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
        - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
  /task/{task_id}/upload_file:
    post:
      tags:
      - Task
      description: 'This method associates the specified file with the specified task ID and uploads the input file. After the file has been uploaded, the processing of the file begins. <br><br>Reports often take time to generate and it''s common for this method to return an HTTP status of 202, which indicates the report is being generated. Use the <b> getTask</b> with the task ID or <b> getTasks</b> to determine the status of a report. <br><br>The status flow is <code>QUEUED</code> &gt; <code>IN_PROCESS</code> &gt; <code>COMPLETED</code> or <code>COMPLETED_WITH_ERROR</code>. When the status is <code>COMPLETED</code> or <code>COMPLETED_WITH_ERROR</code>, this indicates the file has been processed and the order report can be downloaded. If there are errors, they will be indicated in the report file. <br /><br />For details of how this method is used in the upload flow, see <a href="/api-docs/sell/static/orders/generating-and-retrieving-order-reports.html">Working with Order Feeds</a> in the Selling Integration Guide. <br><br>This call does not have a JSON Request payload but uploads the file as form-data. For example:<br /> <pre> fileName: &quot;AddFixedPriceItem_Macbook.xml&quot; <br /> name: &quot;file&quot; <br /> type: &quot;form-data&quot; <br /> file: @&quot;/C:/Users/.../AddFixedPriceItem_Macbook.7z&quot;</pre>See <a href="/api-docs/sell/feed/resources/task/methods/uploadFile#h2-samples">Samples</a> for information.<p><span class="tablenote"><strong>Note:</strong> This method applies to all <a href="/api-docs/sell/static/feed/fx-feeds-quick-reference.html#availabl" target="_blank">Seller Hub feed types</a>, and to all <a href="/api-docs/sell/static/feed/lms-feeds-quick-reference.html#Availabl" target="_blank">LMS feed types</a> except <code>LMS_ORDER_REPORT</code> and <code>LMS_ACTIVE_INVENTORY_REPORT</code>.</span></p><p> <span class="tablenote"><b>Note:</b> You must use a <strong>Content-Type</strong> header with its value set to "<strong>multipart/form-data</strong>". See <a href="/api-docs/sell/feed/resources/task/methods/uploadFile#h2-samples">Samples</a> for information.</span></p><p><span class="tablenote"><b>Note:</b> For LMS feed types, upload a regular XML file or an XML file in zipped format (both formats are allowed).</span></p>'
      operationId: uploadFile
      parameters:
      - name: task_id
        in: path
        description: This path parameter is the unique identifier of the task associated with the file that will be uploaded.<br><br>Use the <a href="/api-docs/sell/feed/resources/task/methods/getTasks" target="_blank ">getTasks</a> method to retrieve task IDs.
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: This header indicates the format of the request body provided by the client. Its value should be set to <b>multipart/form-data</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '160020':
                domain: API_FEED
                category: REQUEST
                description: The format of the file to be uploaded is invalid. {additionalInfo}
              '160023':
                domain: API_FEED
                category: REQUEST
                description: Task {taskID} cannot upload a file.
              '160026':
                domain: API_FEED
                category: REQUEST
                description: This task has expired and you cannot use it to upload a file. You must upload a file within a hour of creating the task.
              '160028':
                domain: API_FEED
                category: REQUEST
                description: The file you tried to upload is too large. Please try using a smaller file. For more information, see the documentation for this API.
              '160100':
                domain: API_FEED
                category: REQUEST
                description: Payload not found. Make sure your file is uploaded inside the Request Body under the key name 'file'.
        '403':
          description: Forbidden
          x-response-codes:
            errors:
              '160002':
                domain: API_FEED
                category: REQUEST
                description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
        '404':
          description: Not Found
          x-response-codes:
            errors:
              '160003':
                domain: API_FEED
                category: REQUEST
                description: Task {taskID} does not exist.
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '160001':
                domain: API_FEED
                category: APPLICATION
                description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.inventory
        - https://api.ebay.com/oauth/api_scope/sell.fulfillment
        - https://api.ebay.com/oauth/api_scope/sell.marketing
        - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
        - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
components:
  schemas:
    CreateTaskRequest:
      type: object
      properties:
        feedType:
          type: string
          description: The feed type associated with the task. Available feed types:<br><ul><li><a href="/api-docs/sell/static/feed/lms-feeds-quick-reference.html#trading-upload-feed-types" target="_blank">Inventory upload feed types</a></li><li><a href="/api-docs/sell/static/feed/lms-feeds-quick-reference.html#merchant-data-upload-feed-types" target="_blank">Fulfillment upload feed types</a></li><li><a href="/api-docs/sell/static/feed/fx-feeds-quick-reference.html#availabl" target="_blank">Seller Hub feed types</a></li></ul>
        schemaVersion:
          type: string
          description: The schemaVersion/version number of the file format:<br><ul><li><a href="/api-docs/sell/static/feed/lms-feeds-quick-reference.html#Version" target="_blank">Version Details / Schema Version</a></li><li><a href="/api-docs/sell/static/feed/fx-feeds-quick-reference.html#schema" target="_blank">Seller Hub feed schema version</a></li></ul>
      description: The type that defines the fields for the <b> createTask</b> method.
    TaskCollection:
      type: object
      properties:
        href:
          type: string
          description: 'The path to the call URI that produced the current page of results. '
        limit:
          type: integer
          description: The value of the <strong>limit</strong> parameter submitted in the request, which is the maximum number of tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method. <p> <span class="tablenote"><strong>Note:</strong> Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.</span></p><p> <span class="tablenote"><strong>Note:</strong> If this is the last or only page of the result set, the page may contain fewer tasks than the <strong>limit</strong> value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the <strong>total</strong> value was <code>120</code> (120 total tasks) and the <strong>limit</strong> value was <code>50</code> (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate <strong>getTasks</strong> calls to view all tasks matching the input criteria.</span></p>
          format: int32
        next:
          type: string
          description: The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.
        offset:
          type: integer
          description: 'The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the <b>offset</b> query parameter. <p class="tablenote"><strong>Note: </strong>The items in a paginated result set use a zero-based list where the first item in the list has an offset of <code>0</code>.</p>'
          format: int32
        prev:
          type: string
          description: The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.
        tasks:
          type: array
          description: 'An array of the tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks. '
          items:
            $ref: '#/components/schemas/Task'
        total:
          type: intege

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ebay/refs/heads/main/openapi/ebay-task-api-openapi.yml