ebay_client/sell_feed_v1_oas3.yaml

---
openapi: "3.0.0"
info:
  title: "Feed 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://developer.ebay.com/join/api-license-agreement"
  version: "v1.3.1"
servers:
- url: "https://api.ebay.com{basePath}"
  description: "Production"
  variables:
    basePath:
      default: "/sell/feed/v1"
paths:
  /order_task:
    get:
      tags:
      - "order_task"
      description: "This method returns the details and status for an array of order\
        \ 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 order\
        \ tasks are returned by specifying filters such as the creation date range\
        \ or period of time using <strong>look_back_days</strong>. <br /><br />If\
        \ specifying a <strong>schedule_id</strong>, the schedule template (that the\
        \ <strong>schedule_id</strong> is based on) determines which order tasks are\
        \ returned (see <strong>schedule_id</strong> for additional information).\
        \ Each <strong>schedule_id</strong> applies to one <strong>feed_type</strong>."
      operationId: "getOrderTasks"
      parameters:
      - name: "date_range"
        in: "query"
        description: "The order tasks creation date range. This range is used to filter\
          \ the results. The filtered results are filtered to include only tasks with\
          \ a creation date that is equal to this date or is within specified range.\
          \ Only orders less than 90 days old can be retrieved. Do not use with the\
          \ <strong>look_back_days</strong> parameter. <br /><br /><b>Format: </b>UTC\
          \   <br /><br /> <b> For example: </b> <br /><br />Tasks within a range\
          \  <br /> <code>yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ </code>\
          \ <br /><br /> Tasks created on September 8, 2019<br /> <code>2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z</code><br\
          \ />"
        required: false
        schema:
          type: "string"
      - name: "feed_type"
        in: "query"
        description: "The feed type associated with the order tasks being retrieved.\
          \ The only presently supported value is <code>LMS_ORDER_REPORT</code><br><br>See\
          \ <a href=\"/api-docs/sell/static/feed/lms-feeds-quick-reference.html#merchant-data-reports-download-feed-types\"\
          >Report download feed types</a> for more information.<br><br><span class=\"\
          tablenote\"><b>Note:</b> 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>.</span>"
        required: false
        schema:
          type: "string"
      - name: "limit"
        in: "query"
        description: "The maximum number of order 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\
          \ order tasks 11 thru 20 from the result set.</p><p>If this parameter is\
          \ omitted, the default value is used.</p><p><b>Default:</b> 10 <p><b>Maximum:</b>\
          \ 500</p>"
        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 <strong>date_range</strong> parameter. If both <strong>date_range</strong>\
          \ and <strong>look_back_days</strong> 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 order tasks to skip in the result set before returning\
          \ the first order 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 schedule ID associated with the order tasks being retrieved.\
          \ A schedule periodically generates a report, and these schedules can be\
          \ created with the <a href=\"/api-docs/sell/feed/resources/schedule/methods/createSchedule\"\
          >createSchedule</a> method.<br><br><span class=\"tablenote\"><b>Note:</b>\
          \ Do not use with the <strong>feed_type</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>.</span><br>Use the\
          \ <a href=\"/api-docs/sell/feed/resources/schedule/methods/getSchedules\"\
          >getSchedules</a> method to retrieve schedule IDs."
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OrderTaskCollection"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              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."
              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."
              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."
              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."
              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."
              160029:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'offset' value must be a multiple of the 'limit'\
                  \ value."
        "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."
        "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."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/sell.fulfillment"
    post:
      tags:
      - "order_task"
      description: "This method creates an order download task with filter criteria\
        \ for the order report. When using this method, specify the <b> feedType</b>,\
        \ <b> schemaVersion</b>, and <b> filterCriteria</b> for the report. The method\
        \ returns the <b> location</b> response header containing the getOrderTask\
        \ call URI to retrieve the order task you just created. The URL includes the\
        \ eBay-assigned task ID, which you can use to reference the order task. <br\
        \ /><br />To retrieve the status of the task, use the <b>getOrderTask</b>\
        \ method to retrieve a single task ID or the <b>getOrderTasks</b> method to\
        \ retrieve multiple order task IDs.<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 scope and its corresponding feed type:<ul><li>https://api.ebay.com/oauth/api_scope/sell.fulfillment:\
        \ LMS_ORDER_REPORT</li></ul> </p><p>For details about how this method is used,\
        \ see <a href=\"/api-docs/sell/static/feed/general-feed-tasks.html\" target=\"\
        _blank\">General feed types</a> in the Selling Integration Guide. <p> <span\
        \ class=\"tablenote\"><strong>Note:</strong> At this time, the <strong>createOrderTask</strong>\
        \ method only supports order creation date filters and not modified order\
        \ date filters. Do not include the <strong>modifiedDateRange</strong> filter\
        \ in your request payload.</span></p>"
      operationId: "createOrderTask"
      parameters:
      - 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/CreateOrderTaskRequest"
        required: true
      responses:
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              160018:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'schemaVersion' is invalid."
              160019:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'filterCriteria' is invalid. {additionalInfo}"
              160017:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'feedType' is missing or 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."
        "202":
          description: "Accepted"
        "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."
        "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."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/sell.fulfillment"
  /order_task/{task_id}:
    get:
      tags:
      - "order_task"
      description: "This method retrieves the task details and status of the specified\
        \ task. The input is <strong>task_id</strong>. <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>"
      operationId: "getOrderTask"
      parameters:
      - name: "task_id"
        in: "path"
        description: "This path parameter is the unique identifier of the order task\
          \ being retrieved.<br><br>Use the <a href=\"/api-docs/sell/feed/resources/order_task/methods/getOrderTasks\"\
          >getOrderTasks</a> method to retrieve order task IDs."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OrderTask"
        "400":
          description: "Bad Request"
        "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."
        "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."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/sell.fulfillment"
  /inventory_task:
    get:
      tags:
      - "inventory_task"
      description: "This method searches for multiple tasks of a specific feed type,\
        \ and includes date filters and pagination."
      operationId: "getInventoryTasks"
      parameters:
      - name: "feed_type"
        in: "query"
        description: "The feed type associated with the inventory tasks being retrieved.\
          \ Presently, only one feed type is available:<br><ul><li><code>LMS_ACTIVE_INVENTORY_REPORT</code></li></ul>See\
          \ <a href=\"/api-docs/sell/static/feed/lms-feeds-quick-reference.html#merchant-data-reports-download-feed-types\"\
          \ target=\"_blank\">Report value feed types</a> for more information."
        required: false
        schema:
          type: "string"
      - name: "schedule_id"
        in: "query"
        description: "<span class=\"tablenote\"><b>Note:</b> Schedule functionality\
          \ for ActiveInventoryReport is currently unavailable, so this field is not\
          \ usable.</span>"
        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: "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. <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 March 31, 2021<br /> <code>2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z</code><br\
          \ /><br />"
        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: "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"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InventoryTaskCollection"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              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."
              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."
              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."
              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."
              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."
              160029:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'offset' value must be a multiple of the 'limit'\
                  \ value."
        "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."
        "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."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/sell.inventory"
    post:
      tags:
      - "inventory_task"
      description: "This method creates an inventory-related download task for a specified\
        \ feed type with optional filter criteria. When using this method, specify\
        \ the <strong>feedType</strong>. <br/><br/>This method returns the location\
        \ response header containing the <strong>getInventoryTask</strong> call URI\
        \ to retrieve the inventory task you just created. The URL includes the eBay-assigned\
        \ task ID, which you can use to reference the inventory task.<br/><br/>To\
        \ retrieve the status of the task, use the <strong>getInventoryTask</strong>\
        \ method to retrieve a single task ID or the <strong>getInventoryTasks</strong>\
        \ method to retrieve multiple task IDs.<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>Presently, this method supports\
        \ Active Inventory Report. The <strong>ActiveInventoryReport</strong> returns\
        \ a report that contains price and quantity information for all of the active\
        \ listings for a specific seller. A seller can use this information to maintain\
        \ their inventory on eBay."
      operationId: "createInventoryTask"
      parameters:
      - 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: "The request payload containing the version, feedType, and optional\
          \ filterCriteria."
        content:
          application/json:
            schema:
              description: "The request payload containing the version, feedType,\
                \ and optional filterCriteria."
              $ref: "#/components/schemas/CreateInventoryTaskRequest"
        required: true
      responses:
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              160018:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'schemaVersion' is invalid."
              160019:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'filterCriteria' is invalid. {additionalInfo}"
              160017:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'feedType' is missing or 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."
        "202":
          description: "Accepted"
        "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."
        "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."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/sell.inventory"
  /inventory_task/{task_id}:
    get:
      tags:
      - "inventory_task"
      description: "This method retrieves the task details and status of the specified\
        \ inventory-related task. The input is <strong>task_id</strong>."
      operationId: "getInventoryTask"
      parameters:
      - name: "task_id"
        in: "path"
        description: "This path parameter is the unique identifier of the inventory\
          \ task being retrieved.<br><br> Use the <a href=\"/api-docs/sell/feed/resources/inventory_task/methods/getInventoryTasks\"\
          >getInventoryTasks</a> method to retrieve inventory task IDs."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InventoryTask"
        "400":
          description: "Bad Request"
        "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."
        "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."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/sell.inventory"
  /schedule:
    get:
      tags:
      - "schedule"
      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>."
      operationId: "getSchedules"
      parameters:
      - name: "feed_type"
        in: "query"
        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_ORDER_REPORT</code>.</span>"
        required: true
        schema:
          type: "string"
      - name: "limit"
        in: "query"
        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> 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\
          \ schedules 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: "offset"
        in: "query"
        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 <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"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UserScheduleCollection"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              160017:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'feedType' is missing or invalid."
              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."
              160029:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'offset' value must be a multiple of the 'limit'\
                  \ value."
        "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."
        "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."
      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:
      - "schedule"
      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> as the <strong>feedType</strong> of the associated\
        \ schedule template. When creating the schedule, if available from the template,\
        \ you can specify a preferred trigger hour, day of the week, or day of the\
        \ month. These and other fields are conditionally available as specified by\
        \ the template.<p> <span class=\"tablenote\"><strong>Note:</strong> Make sure\
        \ to include all fields required by the schedule template (<strong>scheduleTemplateId</strong>).\
        \ Call the <strong>getScheduleTemplate</strong> method (or the <strong>getScheduleTemplates</strong>\
        \ method), to find out which fields are required or optional. If a field is\
        \ optional and a default value is provided by the template, the default value\
        \ will be used if omitted from the payload.</span></p>A successful call returns\
        \ the location response header containing the <strong>getSchedule</strong>\
        \ call URI to retrieve the schedule you just created. The URL includes the\
        \ eBay-assigned schedule ID, which you can use to reference the schedule task.\
        \ <br /><br />To retrieve the details of the create schedule task, use the\
        \ <strong>getSchedule</strong> method for a single schedule ID or the <strong>getSchedules</strong>\
        \ method to retrieve all schedule details for the specified <strong>feed_type</strong>.\
        \ The number of schedules for each feedType is limited. Error code 160031\
        \ is returned when you have reached this maximum.<p> <span class=\"tablenote\"\
        ><strong>Note:</strong> Except for schedules with a HALF-HOUR frequency, all\
        \ schedules will ideally run at the start of each hour ('00' minutes). Actual\
        \ start time may vary time may vary due to load and other factors.</span></p>"
      operationId: "createSchedule"
      parameters:
      - 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: "In the request payload: <strong>feedType</strong> and <strong>scheduleTemplateId</strong>\
          \ are required; <strong>scheduleName</strong> is optional; <strong>preferredTriggerHour</strong>,\
          \ <strong>preferredTriggerDayOfWeek</strong>, <strong>preferredTriggerDayOfMonth</strong>,\
          \ <strong>scheduleStartDate</strong>, <strong>scheduleEndDate</strong>,\
          \ and <strong>schemaVersion</strong> are conditional."
        content:
          application/json:
            schema:
              description: "In the request payload: <strong>feedType</strong> and\
                \ <strong>scheduleTemplateId</strong> are required; <strong>scheduleName</strong>\
                \ is optional; <strong>preferredTriggerHour</strong>, <strong>preferredTriggerDayOfWeek</strong>,\
                \ <strong>preferredTriggerDayOfMonth</strong>, <strong>scheduleStartDate</strong>,\
                \ <strong>scheduleEndDate</strong>, and <strong>schemaVersion</strong>\
                \ are conditional."
              $ref: "#/components/schemas/CreateUserScheduleRequest"
        required: true
      responses:
        "201":
          description: "Created"
          headers:
            Location:
              schema:
                type: "string"
                description: "The URL of the schedule, which includes the id."
          content:
            application/json:
              schema:
                type: "object"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              160034:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The '{fieldName}' is invalid, missing, or not allowed."
              160032:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'scheduleTemplateId' is invalid. Call the getScheduleTemplates\
                  \ method to get the available schedule templates."
              160017:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'feedType' is missing or invalid."
              160033:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'feedType' is not associated with the 'scheduleTemplateId'.\
                  \ Please provide a 'feedType' that matches the 'scheduleTemplateId'.\
                  \ Call the getScheduleTemplates method to get the available schedule\
                  \ templates."
              160036:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The '{fieldName}' is in the past."
              160037:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'scheduleEndDate' is before 'scheduleStartDate'."
        "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."
        "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:
              160035:
                domain: "API_FEED"
                category: "BUSINESS"
                description: "Duplicate schedule (a matching schedule already exists).\
                  \ Use the getSchedules method to see the existing schedules."
              160040:
                domain: "API_FEED"
                category: "BUSINESS"
                description: "The 'scheduleTemplateId' is inactive. You cannot create\
                  \ or modify a schedule with an inactive 'scheduleTemplateId'."
              160031:
                domain: "API_FEED"
                category: "BUSINESS"
                description: "You have reached the maximum number of subscribed schedules\
                  \ for the 'feedType' {feedType}. To subscribe to another schedule,\
                  \ you must delete one."
      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"
  /schedule/{schedule_id}:
    get:
      tags:
      - "schedule"
      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 <strong>schedule_id</strong>."
      operationId: "getSchedule"
      parameters:
      - name: "schedule_id"
        in: "path"
        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/methods/getSchedules\"\
          \ target=\"_blank \">getSchedules</a> method to retrieve schedule IDs."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UserScheduleResponse"
        "400":
          description: "Bad Request"
        "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."
        "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:
              160038:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The schedule id {schedule_id} does not exist."
      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"
    put:
      tags:
      - "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 using the changed template.<p> <span class=\"\
        tablenote\"><strong>Note:</strong> Make sure to include all fields required\
        \ by the schedule template (<strong>scheduleTemplateId</strong>). Call the\
        \ <strong>getScheduleTemplate</strong> method (or the <strong>getScheduleTemplates</strong>\
        \ method), to find out which fields are required or optional. If you do not\
        \ know the <strong>scheduleTemplateId</strong>, call the <strong>getSchedule</strong>\
        \ method to find out.</span></p>"
      operationId: "updateSchedule"
      parameters:
      - name: "schedule_id"
        in: "path"
        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/getSchedules\"\
          \ target=\"_blank \">getSchedules</a> method to retrieve schedule 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>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: "In the request payload: <strong>scheduleName</strong> is optional;\
          \ <strong>preferredTriggerHour</strong>, <strong>preferredTriggerDayOfWeek</strong>,\
          \ <strong>preferredTriggerDayOfMonth</strong>, <strong>scheduleStartDate</strong>,\
          \ <strong>scheduleEndDate</strong>, and <strong>schemaVersion</strong> are\
          \ conditional."
        content:
          application/json:
            schema:
              description: "In the request payload: <strong>scheduleName</strong>\
                \ is optional; <strong>preferredTriggerHour</strong>, <strong>preferredTriggerDayOfWeek</strong>,\
                \ <strong>preferredTriggerDayOfMonth</strong>, <strong>scheduleStartDate</strong>,\
                \ <strong>scheduleEndDate</strong>, and <strong>schemaVersion</strong>\
                \ are conditional."
              $ref: "#/components/schemas/UpdateUserScheduleRequest"
        required: true
      responses:
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              160034:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The '{fieldName}' is invalid, missing, or not allowed."
              160036:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The '{fieldName}' is in past."
              160037:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'scheduleEndDate' is before 'scheduleStartDate'."
        "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."
        "204":
          description: "No Content"
        "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:
              160038:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The schedule id {schedule_id} does not exist."
        "409":
          description: "Conflict"
          x-response-codes:
            errors:
              160040:
                domain: "API_FEED"
                category: "BUSINESS"
                description: "The 'scheduleTemplateId' is inactive. You cannot create\
                  \ or modify a schedule with an inactive 'scheduleTemplateId'."
      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"
    delete:
      tags:
      - "schedule"
      description: "This method deletes an existing schedule. Specify the schedule\
        \ to delete using the <strong>schedule_id</strong> path parameter."
      operationId: "deleteSchedule"
      parameters:
      - name: "schedule_id"
        in: "path"
        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\"\
          \ target=\"_blank \">getSchedules</a> method to retrieve schedule IDs."
        required: true
        schema:
          type: "string"
      responses:
        "400":
          description: "Bad Request"
        "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."
        "204":
          description: "No Content"
        "404":
          description: "Not Found"
          x-response-codes:
            errors:
              160038:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The schedule id {schedule_id} does not exist."
      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"
  /schedule/{schedule_id}/download_result_file:
    get:
      tags:
      - "schedule"
      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>schedule_id</strong> path parameter to download its\
        \ last generated file."
      operationId: "getLatestResultFile"
      parameters:
      - name: "schedule_id"
        in: "path"
        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/resources/schedule/methods/getSchedules\" target=\"\
          _blank \">getSchedules</a> method to retrieve schedule IDs."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          headers:
            content-disposition:
              schema:
                type: "string"
                description: "It contains the file metadata like file name."
          content:
            application/octet-stream:
              schema:
                $ref: "#/components/schemas/StreamingOutput"
        "400":
          description: "Bad Request"
        "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."
        "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:
              160038:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The schedule id {schedule_id} does not exist."
              160021:
                domain: "API_FEED"
                category: "REQUEST"
                description: "No file found for 'schedule_id' {scheduleID}."
      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"
  /schedule_template/{schedule_template_id}:
    get:
      tags:
      - "schedule"
      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 if you do not know the <strong>schedule_template_id</strong>."
      operationId: "getScheduleTemplate"
      parameters:
      - name: "schedule_template_id"
        in: "path"
        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/getScheduleTemplates\"\
          \ target=\"_blank \">getScheduleTemplates</a> method to retrieve schedule\
          \ template IDs.<br><br><span class=\"tablenote\"><b>Note:</b> Template schedules\
          \ are currently only available for <code>LMS_ORDER_REPORT</code>.</span>"
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ScheduleTemplateResponse"
        "400":
          description: "Bad Request"
        "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."
        "404":
          description: "Not Found"
          x-response-codes:
            errors:
              160039:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The schedule template id {schedule_template_id} does\
                  \ not exist. Please provide a valid schedule template id as contained\
                  \ in the documentation or by calling the getScheduleTemplates method."
      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"
  /schedule_template:
    get:
      tags:
      - "schedule"
      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</strong>."
      operationId: "getScheduleTemplates"
      parameters:
      - name: "feed_type"
        in: "query"
        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_REPORT</code>.</span>"
        required: true
        schema:
          type: "string"
      - name: "limit"
        in: "query"
        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</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\
          \ schedule templates 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: "offset"
        in: "query"
        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>\
          \ 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"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ScheduleTemplateCollection"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              160017:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'feedType' is missing or invalid."
              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."
              160029:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'offset' value must be a multiple of the 'limit'\
                  \ value."
        "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:
    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:
              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."
              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."
              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."
              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."
              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."
              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."
              160029:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'offset' value must be a multiple of the 'limit'\
                  \ value."
        "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."
        "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."
      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.<br><br><span class=\"tablenote\"><b>Note:</b> When\
          \ listing the items in the feed file on the French Canada and French Belgium\
          \ marketplaces, also set the <b>Accept-Language</b> header as needed.</span>"
        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"
      - name: "Accept-Language"
        in: "header"
        description: "The Accept-Language header is required for listing items in\
          \ the French Canada and French Belgium marketplaces. Set the following headers\
          \ to list items on these marketplaces:<br><ul><li><b>French Canada</b>:\
          \ Set the <b>X-EBAY-C-MARKETPLACE-ID</b> header value to <code>EBAY_CA</code>\
          \ and include the <b>Accept-Language</b> header with a value of <code>fr-CA</code>.</li><li><b>French\
          \ Belgium</b>: Set the <b>X-EBAY-C-MARKETPLACE-ID</b> header value to <code>EBAY_BE</code>\
          \ and include the <b>Accept-Language</b> header with a value of <code>fr-BE</code>.</li></ul>"
        required: false
        schema:
          type: "string"
      requestBody:
        description: "description not needed"
        content:
          application/json:
            schema:
              description: "description not needed"
              $ref: "#/components/schemas/CreateTaskRequest"
        required: true
      responses:
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              160018:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'schemaVersion' is invalid."
              160017:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'feedType' is missing or 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."
        "202":
          description: "Accepted"
        "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."
        "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."
      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"
        "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."
        "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. "
      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"
        "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."
        "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}."
      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"
        "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."
        "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."
      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:
              160023:
                domain: "API_FEED"
                category: "REQUEST"
                description: "Task {taskID} cannot upload a file."
              160020:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The format of the file to be uploaded is invalid. {additionalInfo}"
              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'."
              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."
        "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."
        "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."
      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"
  /customer_service_metric_task:
    get:
      tags:
      - "customer_service_metric_task"
      description: "Use this method to return an array of customer service metric\
        \ tasks. You can limit the tasks returned by specifying a date range. </p>\
        \ <p> <span class=\"tablenote\"><strong>Note:</strong> You can pass in either\
        \ the <code>look_back_days </code>or<code> date_range</code>, but not both.</span></p>"
      operationId: "getCustomerServiceMetricTasks"
      parameters:
      - name: "date_range"
        in: "query"
        description: "The task creation date range. The results are filtered to include\
          \ only tasks with a creation date that is equal to the dates specified or\
          \ is within the specified range. Do not use with the <code>look_back_days</code>\
          \ parameter.<p><strong>Format: </strong>UTC</p><p>For example, tasks within\
          \ a range: </p><p><code>yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ\
          \ </code></p><p>Tasks created on March 8, 2020</p><p><code>2020-03-08T00:00.00.000Z..2020-03-09T00:00:00.000Z</code></p><p><b>Maximum:\
          \ </b>90 days</p>"
        required: false
        schema:
          type: "string"
      - name: "feed_type"
        in: "query"
        description: "The feed type associated with the tasks being retrieved. The\
          \ only presently supported value is <code>CUSTOMER_SERVICE_METRICS_REPORT</code>."
        required: false
        schema:
          type: "string"
      - name: "limit"
        in: "query"
        description: "The number of customer service metric tasks to return per page\
          \ of the result set. Use this parameter in conjunction with the offset parameter\
          \ to control the pagination of the output. <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.</p><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><b>Default:</b> 10 <p><b>Maximum:</b>\
          \ 500</p>"
        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. <p><b>Default value:</b> 7</p><p><b>Range:</b> 1-90 (inclusive)</p>"
        required: false
        schema:
          type: "string"
      - name: "offset"
        in: "query"
        description: "The number of customer service metric 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. <br /><br /><b>Default: </b>0"
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CustomerServiceMetricTaskCollection"
        "400":
          description: "Bad Request"
          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."
              160006:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'feed_type' {feedTypeValue} is invalid."
              160005:
                domain: "API_FEED"
                category: "REQUEST"
                description: "Both 'feed_type' and 'schedule_id' were provided. Please\
                  \ remove one of them."
              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."
              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."
              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."
              160029:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'offset' value must be a multiple of the 'limit'\
                  \ value."
        "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."
        "403":
          description: "Forbidden"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
    post:
      tags:
      - "customer_service_metric_task"
      description: "<p>Use this method to create a customer service metrics download\
        \ task with filter criteria for the customer service metrics report. When\
        \ using this method, specify the <strong>feedType</strong> and <strong>filterCriteria</strong>\
        \ including both <strong>evaluationMarketplaceId</strong> and <strong>customerServiceMetricType</strong>\
        \ for the report. The method returns the location response header containing\
        \ the call URI to use with <strong>getCustomerServiceMetricTask</strong> to\
        \ retrieve status and details on the task.</p><p>Only CURRENT Customer Service\
        \ Metrics reports can be generated with the Sell Feed API. PROJECTED reports\
        \ are not supported at this time. See the <a href=\"/api-docs/sell/analytics/resources/customer_service_metric/methods/getCustomerServiceMetric\"\
        >getCustomerServiceMetric</a> method document in the Analytics API for more\
        \ information about these two types of reports.</p><p><span class=\"tablenote\"\
        ><strong>Note:</strong> Before calling this API, retrieve the summary of the\
        \ seller's performance and rating for the customer service metric by calling\
        \ <strong>getCustomerServiceMetric</strong> (part of the <a href=\"/api-docs/sell/analytics/resources/methods\"\
        >Analytics API</a>). You can then populate the create task request fields\
        \ with the values from the response. This technique eliminates failed tasks\
        \ that request a report for a <strong>customerServiceMetricType</strong> and\
        \ <strong>evaluationMarketplaceId</strong> that are without evaluation.</span></p>"
      operationId: "createCustomerServiceMetricTask"
      parameters:
      - name: "Accept-Language"
        in: "header"
        description: "Use this header to specify the natural language in which the\
          \ authenticated user desires the response. For example, <code>en-US</code>\
          \ for English or <code>de-DE</code> for German."
        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: "Request payload containing version, feedType, and optional filterCriteria."
        content:
          application/json:
            schema:
              description: "Request payload containing version, feedType, and optional\
                \ filterCriteria."
              $ref: "#/components/schemas/CreateServiceMetricsTaskRequest"
        required: true
      responses:
        "202":
          description: "Accepted"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              160018:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'schemaVersion' is invalid."
              160017:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'feedType' is missing or invalid."
              164502:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'listingCategories' in 'filterCriteria' or some\
                  \ part of the 'listingCategories' is invalid. {additionalInfo}"
              164503:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'shippingRegions' in 'filterCriteria' or some part\
                  \ of the 'shippingRegions' is invalid. {additionalInfo}"
              164500:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'customerServiceMetricType' in 'filterCriteria'\
                  \ is not a valid type. Valid metric types are ITEM_NOT_AS_DESCRIBED\
                  \ or ITEM_NOT_RECEIVED."
              164501:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'evaluationMarketplaceId' in 'filterCriteria' is\
                  \ not a supported marketplace. For a complete list of the supported\
                  \ marketplace IDs, see the documentation."
              164506:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'listingCategories' is not applicable to the 'customerServiceMetricType'\
                  \ {customerServiceMetricType} in 'filterCriteria'."
              164507:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'shippingRegions' is not applicable to the 'customerServiceMetricType'\
                  \ {customerServiceMetricType} in 'filterCriteria'."
              160024:
                domain: "API_FEED"
                category: "REQUEST"
                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."
              164504:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The Accept-Language header is missing or invalid."
              160025:
                domain: "API_FEED"
                category: "REQUEST"
                description: "You have exceeded the maximum number of feed tasks that\
                  \ can be created or processed in a given period (hour or day). Wait\
                  \ until the present period ends before adding tasks. For more information,\
                  \ see the documentation for this API."
              164505:
                domain: "API_FEED"
                category: "REQUEST"
                description: "The 'filterCriteria' is missing or invalid."
        "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."
        "403":
          description: "Forbidden"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
  /customer_service_metric_task/{task_id}:
    get:
      tags:
      - "customer_service_metric_task"
      description: "<p>Use this method to retrieve customer service metric task details\
        \ for the specified task. The input is <strong>task_id</strong>.</p>"
      operationId: "getCustomerServiceMetricTask"
      parameters:
      - name: "task_id"
        in: "path"
        description: "This path parameter is the unique identifier of the customer\
          \ service metric task being retrieved.<br><br>Use the <a href=\"/api-docs/sell/feed/resources/customer_service_metric_task/methods/getCustomerServiceMetricTasks\"\
          >getCustomerServiceMetricTasks</a> method to retrieve task IDs."
        required: true
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceMetricsTask"
        "400":
          description: "Bad Request"
          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."
              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."
        "403":
          description: "Forbidden"
        "404":
          description: "Not Found"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
components:
  schemas:
    CreateInventoryTaskRequest:
      type: "object"
      properties:
        feedType:
          type: "string"
          description: "The feed type associated with the inventory task you are about\
            \ to create. Presently, only one feed type is available:<br><ul><li><code>LMS_ACTIVE_INVENTORY_REPORT</code></li></ul>See\
            \ <a href=\"/api-docs/sell/static/feed/lms-feeds-quick-reference.html#merchant-data-reports-download-feed-types\"\
            \ target=\"_blank\">Report download feed types</a> for more information."
        filterCriteria:
          description: "This container allows a seller to create an ActiveInventoryReport\
            \ for a single listing format."
          $ref: "#/components/schemas/InventoryFilterCriteria"
        schemaVersion:
          type: "string"
          description: "The version number of the inventory task to use for the <b>feedType</b>.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field <b>must</b> have a value\
            \ of <code>1.0</code>.</span>"
      description: "This type defines inventory-related download task request fields."
    CreateOrderTaskRequest:
      type: "object"
      properties:
        feedType:
          type: "string"
          description: "The feed type associated with the task. The only presently\
            \ supported value is <code>LMS_ORDER_REPORT</code>.<br><br>See <a href=\"\
            /api-docs/sell/static/feed/lms-feeds-quick-reference.html#merchant-data-reports-download-feed-types\"\
            \ target=\"_blank\">Report download feed types</a> for more information."
        filterCriteria:
          description: "The container for the filter fields. This container is used\
            \ to set the filter criteria for the order report. A seller can set date\
            \ range filters and/or can retrieve orders in a specific state."
          $ref: "#/components/schemas/OrderFilterCriteria"
        schemaVersion:
          type: "string"
          description: "The schema version of the LMS OrderReport. For the <code>LMS_ORDER_REPORT</code>\
            \ feed type, see the <a href=\"/devzone/merchant-data/CallRef/OrderReport.html#OrderReport\"\
            >OrderReport</a> reference page to see the present schema version. The\
            \ <b> schemaVersion</b> value is the version number shown at the top of\
            \ the <b> OrderReport</b> page. <br /><br /><b>Restriction: </b> This\
            \ value must be 1113 or higher. The OrderReport schema version is updated\
            \ about every two weeks. All version numbers are odd numbers (even numbers\
            \ are skipped). For example, the next release version after '1113' is\
            \ '1115'."
      description: "The type that defines the fields for the <b> createOrderTask</b>\
        \ request."
    CreateServiceMetricsTaskRequest:
      type: "object"
      properties:
        feedType:
          type: "string"
          description: "The <strong>feedType</strong> specified for the customer service\
            \ metric task being created. The report lists the transaction details\
            \ that contribute to the service metrics evaluation. Supported types include:<p><code>CUSTOMER_SERVICE_METRICS_REPORT</code></p>"
        filterCriteria:
          description: "This container is used to customize and set criteria for Customer\
            \ Service Metric report that will be associated with the task."
          $ref: "#/components/schemas/CustomerServiceMetricsFilterCriteria"
        schemaVersion:
          type: "string"
          description: "The version number of the customer service metric.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field <b>must</b> have a value\
            \ of <code>1.0</code>.</span>"
      description: "The type that defines the fields for the Customer Service Metric\
        \ reports generated with the Feed API."
    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."
    CreateUserScheduleRequest:
      type: "object"
      properties:
        feedType:
          type: "string"
          description: "The name of the feed type for the created schedule.<br><br>\
            \ Use the <a href=\"/api-docs/sell/feed/resources/schedule/methods/getScheduleTemplates\"\
            >getScheduleTemplates</a> method to retrieve the feed type of a schedule\
            \ template.<br><br><span class=\"tablenote\"><b>Note:</b> Schedules are\
            \ currently only available for <code>LMS_ORDER_REPORT</code>.</span>"
        preferredTriggerDayOfMonth:
          type: "integer"
          description: "The preferred day of the month to trigger the schedule. This\
            \ field can be used with <strong>preferredTriggerHour</strong> for monthly\
            \ schedules. The last day of the month is used for numbers larger than\
            \ the actual number of days in the month. <br /><br />This field is available\
            \ as specified by the template (<strong>scheduleTemplateId</strong>).\
            \ The template can specify this field as optional or required, and optionally\
            \ provides a default value.<br /><br /><b>Minimum: </b>1<br /><br /><b>Maximum:\
            \ </b>31"
          format: "int32"
        preferredTriggerDayOfWeek:
          type: "string"
          description: "The preferred day of the week to trigger the schedule. This\
            \ field can be used with <strong>preferredTriggerHour</strong> for weekly\
            \ schedules. <br /><br />This field is available as specified by the template\
            \ (<strong>scheduleTemplateId</strong>). The template can specify this\
            \ field as optional or required, and optionally provides a default value.\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:DayOfWeekEnum'>eBay\
            \ API documentation</a>"
        preferredTriggerHour:
          type: "string"
          description: "The preferred two-digit hour of the day to trigger the schedule.\
            \ <br /><br />This field is available as specified by the template (<strong>scheduleTemplateId</strong>).\
            \ The template can specify this field as optional or required, and optionally\
            \ provides a default value.<br /><br /><b>Format:</b> UTC <code>hhZ</code><br\
            \ /><br />For example, the following represents 11:00 am UTC:<code> 11Z</code>"
        scheduleEndDate:
          type: "string"
          description: "The timestamp on which the report generation (subscription)\
            \ ends. After this date, the schedule status becomes <code>INACTIVE</code>.\
            \ <br /><br />Use this field, if available, to end the schedule in the\
            \ future. This value must be later than <strong>scheduleStartDate</strong>\
            \ (if supplied). This field is available as specified by the template\
            \ (<strong>scheduleTemplateId</strong>). The template can specify this\
            \ field as optional or required, and optionally provides a default value.<br\
            \ /><br /><b>Format:</b> UTC <code>yyyy-MM-dd<strong>T</strong>HH<strong>Z</strong></code><br\
            \ /><br />For example, the following represents UTC October 10, 2021 at\
            \ 10:00 AM:<br /><code>2021-10-10T10Z</code>"
        scheduleName:
          type: "string"
          description: "The schedule name assigned by the user for the created schedule."
        scheduleStartDate:
          type: "string"
          description: "The timestamp to start generating the report. After this timestamp,\
            \ the schedule status becomes active until either the <strong>scheduleEndDate</strong>\
            \ occurs or the <strong>scheduleTemplateId</strong> becomes inactive.\
            \ <br /><br />Use this field, if available, to start the schedule in the\
            \ future but before the <strong>scheduleEndDate</strong> (if supplied).\
            \ This field is available as specified by the template <strong>(scheduleTemplateId)</strong>.\
            \ The template can specify this field as optional or required, and optionally\
            \ provides a default value.<br /><br /><b>Format:</b> UTC <code>yyyy-MM-dd<strong>T</strong>HH<strong>Z</strong></code><br\
            \ /><br />For example, the following represents a schedule start date\
            \ of UTC October 01, 2020 at 12:00 PM:<br /><code> 2020-01-01T12Z</code>"
        scheduleTemplateId:
          type: "string"
          description: "The unique identifier of the template to be used for this\
            \ schedule. <br><br>Use the <a href=\"/api-docs/sell/feed/resources/schedule/methods/getScheduleTemplates\"\
            >getScheduleTemplates</a> method to retrieve the schedule template ID.\
            \ This method requires a schedule template ID that is <code>ACTIVE</code>.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> Schedules are currently only available\
            \ for <code>LMS_ORDER_REPORT</code>.</span>"
        schemaVersion:
          type: "string"
          description: "The schema version of a schedule."
      description: "The type that defines the fields for the <strong>createSchedule</strong>\
        \ method."
    CustomerServiceMetricTaskCollection:
      type: "object"
      properties:
        href:
          type: "string"
          description: "The URI of 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>\
            \ Even 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 limit 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>getCustomerServiceMetricTasks</strong> calls\
            \ to view all tasks matching the input criteria.</span></p>"
          format: "int32"
        next:
          type: "string"
          description: "The relative 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 returning\
            \ the first 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 URI for the previous page of results. This parameter is\
            \ returned if a previous page of results from the result set exists."
        tasks:
          type: "array"
          description: "An array of the customer service 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/ServiceMetricsTask"
        total:
          type: "integer"
          description: "The total number of tasks that match the criteria."
          format: "int32"
      description: "This type defines customer service metric task response fields."
    CustomerServiceMetricsFilterCriteria:
      type: "object"
      properties:
        customerServiceMetricType:
          type: "string"
          description: "An enumeration value that specifies the customer service metric\
            \ that eBay tracks to measure seller performance.<br><br>See <a href=\"\
            /api-docs/sell/feed/types/api:CustomerServiceMetricTypeEnum\">CustomerServiceMetricTypeEnum</a>\
            \ for values. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:CustomerServiceMetricTypeEnum'>eBay\
            \ API documentation</a>"
        evaluationMarketplaceId:
          type: "string"
          description: "An enumeration value that specifies the eBay marketplace where\
            \ the evaluation occurs.<br><br>See <a href=\"/api-docs/sell/feed/types/bas:MarketplaceIdEnum\"\
            >MarketplaceIdEnum</a> for values. For implementation help, refer to <a\
            \ href='https://developer.ebay.com/api-docs/sell/feed/types/bas:MarketplaceIdEnum'>eBay\
            \ API documentation</a>"
        listingCategories:
          type: "array"
          description: "A list of listing category IDs on which the service metric\
            \ is measured. A seller can use one or more L1 (top-level) eBay categories\
            \ to get metrics specific to those L1 categories. The Category IDs for\
            \ each L1 category are required. Category ID values for L1 categories\
            \ can be retrieved using the Taxonomy API.<p> <span class=\"tablenote\"\
            ><strong>Note: </strong>Pass this attribute to narrow down your filter\
            \ results for the <code>ITEM_NOT_AS_DESCRIBED</code> customerServiceMetricType.</span></p>\
            \ <p>Supported categories include:</p><p><code>primary(L1) category Id</code></p>"
          items:
            type: "string"
        shippingRegions:
          type: "array"
          description: "A list of shipping region enumeration values on which the\
            \ service metric is measured. This comma delimited array allows the seller\
            \ to customize the report to focus on domestic or international shipping.\
            \ <p> <span class=\"tablenote\"><strong>Note: </strong>Pass this attribute\
            \ to narrow down your filter results for the <code>ITEM_NOT_RECEIVED</code>\
            \ customerServiceMetricType.</span></p> <p>Supported categories include:</p><p><code>primary(L1)\
            \ category Id</code></p>See <strong>ShippingRegionTypeEnum</strong> for\
            \ values"
          items:
            type: "string"
            description: " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:ShippingRegionTypeEnum'>eBay\
              \ API documentation</a>"
      description: "A complex data type that filters data for report creation. See\
        \ <strong>CustomerServiceMetricsFilterCriteria</strong> for fields and descriptions."
    DateRange:
      type: "object"
      properties:
        from:
          type: "string"
          description: "The beginning date in the range. If the parent type is included,\
            \ both the <strong>from</strong> and/or the <strong>to</strong> fields\
            \ become conditionally required.<br /><br /><b>Format: </b>UTC <code>yyyy-MM-ddThh:mm:ss.SSSZ\
            \ </code> <br /><br /> <b> For example: </b> Tasks within a range  <br\
            \ /> <code>yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ </code>\
            \ <br /><br /> Tasks created on March 31, 2021  <br /><code>2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z</code>\
            \    "
        to:
          type: "string"
          description: "The end date for the date range, which is inclusive. If the\
            \ parent type is included, both the <strong>from</strong> and/or the <strong>to</strong>\
            \ fields become conditionally required.  <br /><br /> <b> For example:\
            \ </b> <br /><br />Tasks within a range  <br /> <code>yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ\
            \ </code> <br /><br /> Tasks created on March 31, 2021 <br /> <code>2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z</code>\
            \  "
      description: "The type that defines the fields for a date range."
    Error:
      type: "object"
      properties:
        category:
          type: "string"
          description: "Identifies the type of erro."
        domain:
          type: "string"
          description: "Name for the primary system where the error occurred. This\
            \ is relevant for application errors."
        errorId:
          type: "integer"
          description: "A unique number to identify the error."
          format: "int32"
        inputRefIds:
          type: "array"
          description: "An array of request elements most closely associated to the\
            \ error."
          items:
            type: "string"
        longMessage:
          type: "string"
          description: "A more detailed explanation of the error."
        message:
          type: "string"
          description: "Information on how to correct the problem, in the end user's\
            \ terms and language where applicable."
        outputRefIds:
          type: "array"
          description: "An array of request elements most closely associated to the\
            \ error."
          items:
            type: "string"
        parameters:
          type: "array"
          description: "An array of name/value pairs that describe details the error\
            \ condition. These are useful when multiple errors are returned."
          items:
            $ref: "#/components/schemas/ErrorParameter"
        subdomain:
          type: "string"
          description: "Further helps indicate which subsystem the error is coming\
            \ from. System subcategories include: Initialization, Serialization, Security,\
            \ Monitoring, Rate Limiting, etc."
      description: "This type defines the fields that can be returned in an error."
    ErrorParameter:
      type: "object"
      properties:
        name:
          type: "string"
          description: "The object of the error."
        value:
          type: "string"
          description: "The value of the object."
    InventoryFilterCriteria:
      type: "object"
      properties:
        listingFormat:
          type: "string"
          description: "The listing format for the ActiveInventoryReport being created.\
            \ Supported types are:<br><ul><li><code>AUCTION</code></li><li><code>FIXED_PRICE</code></li></ul>\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:ListingFormatEnum'>eBay\
            \ API documentation</a>"
      description: "This container is used to set the filter criteria for the ActiveInventoryReport.\
        \ A seller can create an ActiveInventoryReport for a single listing format."
    InventoryTask:
      type: "object"
      properties:
        taskId:
          type: "string"
          description: "The ID of the task. This ID is generated when the task was\
            \ created by the <strong>createInventoryTask</strong> method."
        status:
          type: "string"
          description: "The status of the task. Users must wait until status is complete\
            \ before moving on to the next step (such as uploading/downloading a file).\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:FeedStatusEnum'>eBay\
            \ API documentation</a>"
        feedType:
          type: "string"
          description: "The feed type associated with the inventory task."
        creationDate:
          type: "string"
          description: "The date the task was created."
        completionDate:
          type: "string"
          description: "The timestamp when the task <strong>status</strong> went into\
            \ the <code>COMPLETED</code>, <code>COMPLETED_WITH_ERROR</code>, or <code>PARTIALLY_PROCESSED</code>\
            \ state. This field is only returned if the status is one of the three\
            \ completed values."
        schemaVersion:
          type: "string"
          description: "The schema version number associated with the task."
        detailHref:
          type: "string"
          description: "The path to the call URI used to retrieve the task. This field\
            \ points to the <strong>getInventoryTask</strong> URI."
        uploadSummary:
          description: "This container provides summary information on an upload feed\
            \ (not applicable for download feed types)."
          $ref: "#/components/schemas/UploadSummary"
        filterCriteria:
          description: "This container is used to set the filter criteria for the\
            \ ActiveInventoryReport. A seller can retrieve listings for a specified\
            \ format."
          $ref: "#/components/schemas/InventoryFilterCriteria"
    InventoryTaskCollection:
      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 inventory tasks to return\
            \ per page, from the result set. A result set is the complete set of tasks\
            \ returned by the method.<br /><br /><span class=\"tablenote\"><strong>Note:</strong>\
            \ Though this parameter is not required to be submitted in the request,\
            \ the parameter defaults to <code>10</code> if omitted. Additionally,\
            \ if this is the last or only page of the result set, the page may contain\
            \ fewer tasks than the <strong>limit</strong> value submitted in the request.</span><br\
            \ /><br />To determine the number of pages in a result set, divide the\
            \ total value (total number of tasks matching the 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>getInventoryTasks</strong>\
            \ calls to view all tasks matching the input criteria."
          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 specified in the request\
            \ with the <strong>offset</strong> query parameter.<br /><br /><span 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>.</span>"
          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 inventory tasks on this page. The tasks are\
            \ sorted by creation date.<br /><br /><span class=\"tablenote\"><strong>Note:</strong>\
            \ An empty array is returned if the filter criteria excludes all tasks.</span>"
          items:
            $ref: "#/components/schemas/InventoryTask"
        total:
          type: "integer"
          description: "The total number of inventory tasks that match the input criteria."
          format: "int32"
    OrderFilterCriteria:
      type: "object"
      properties:
        creationDateRange:
          description: "The creation date range of the orders you want returned. Set\
            \ the date range so it contains less than 10 days (maximum). If you do\
            \ not specify a <strong>DateRange</strong>, results from the last 10 days\
            \ will be returned by default."
          $ref: "#/components/schemas/DateRange"
        modifiedDateRange:
          description: "The modified date range of the orders you want returned. <p>\
            \ <span class=\"tablenote\"><strong>Note:</strong> This container is for\
            \ future use. At this time, the <strong>createOrderTask</strong> method\
            \ only supports order creation date filters and not modified order date\
            \ filters.</span></p>"
          $ref: "#/components/schemas/DateRange"
        orderStatus:
          type: "string"
          description: "The order status of the orders returned. If the filter is\
            \ omitted from createOrderTask call, orders that are in both <code>ACTIVE\
            \ </code>and<code> COMPLETED</code> states are returned. For implementation\
            \ help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:OrderStatusEnum'>eBay\
            \ API documentation</a>"
      description: "The type that defines the fields for the order filters."
    OrderTask:
      type: "object"
      properties:
        completionDate:
          type: "string"
          description: "The timestamp when the task went into the <code>COMPLETED</code>\
            \ or <code>COMPLETED_WITH_ERROR</code> state. This state means that eBay\
            \ has compiled the report for the seller based on the seller’s filter\
            \ criteria, and the seller can run a <strong>getResultFile</strong> call\
            \ to download the report."
        creationDate:
          type: "string"
          description: "The date the task was created."
        detailHref:
          type: "string"
          description: "The path to the call URI used to retrieve the task."
        feedType:
          type: "string"
          description: "The feed type associated with the task."
        filterCriteria:
          description: "A container that returns the filter criteria used."
          $ref: "#/components/schemas/OrderFilterCriteria"
        schemaVersion:
          type: "string"
          description: "The schema version number associated with the create task."
        status:
          type: "string"
          description: "The enumeration value that indicates the state of the task\
            \ that was submitted in the request. See <strong>FeedStatusEnum</strong>\
            \ for information. <p>The values <code>COMPLETED </code>and<code> COMPLETED_WITH_ERROR</code>\
            \ indicate the Order Report file is ready to download.</p> For implementation\
            \ help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:FeedStatusEnum'>eBay\
            \ API documentation</a>"
        taskId:
          type: "string"
          description: "The ID of the task that was submitted in the request."
        uploadSummary:
          description: "This container provides summary information on an upload feed\
            \ (not applicable for download feed types)."
          $ref: "#/components/schemas/UploadSummary"
      description: "The type that defines the fields for the <b> getOrderTask</b>\
        \ response."
    OrderTaskCollection:
      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 order 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 <code>10</code> 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>getOrderTasks</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 order 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/OrderTask"
        total:
          type: "integer"
          description: "The total number of order tasks that match the input criteria."
          format: "int32"
      description: "The type that defines the fields for a paginated result set of\
        \ orders. The response consists of 0 or more sequenced <em> pages</em> where\
        \ each page has 0 or more items."
    ScheduleTemplateCollection:
      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 schedule templates to\
            \ return per page, from the result set. A result set is the complete set\
            \ of schedule templates 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>getScheduleTemplates</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."
        scheduleTemplates:
          type: "array"
          description: "An array of the schedule templates on this page. An empty\
            \ array is returned if the filter criteria excludes all tasks."
          items:
            $ref: "#/components/schemas/ScheduleTemplateResponse"
        total:
          type: "integer"
          description: "The total number of schedule templates that match the input\
            \ criteria."
          format: "int32"
      description: "The type that defines the fields for a paginated result set of\
        \ schedule templates. The response consists of 0 or more sequenced <em> pages</em>\
        \ where each page has 0 or more items."
    ScheduleTemplateResponse:
      type: "object"
      properties:
        feedType:
          type: "string"
          description: "The feed type of the schedule template. <p> <span class=\"\
            tablenote\"><strong>Note:</strong> When calling <strong>createSchedule</strong>\
            \ and <strong>updateSchedule</strong> methods you must match the feed\
            \ type specified by the schedule template (this feedType).</span></p>"
        frequency:
          type: "string"
          description: "This field specifies how often the schedule is generated.\
            \ If set to <code>HALF_HOUR</code> or <code>ONE_HOUR</code>, you cannot\
            \ set a <strong>preferredTriggerHour</strong> using <strong>createSchedule</strong>\
            \ or <strong>updateSchedule</strong>. For implementation help, refer to\
            \ <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:FrequencyEnum'>eBay\
            \ API documentation</a>"
        name:
          type: "string"
          description: "The template name provided by the template."
        scheduleTemplateId:
          type: "string"
          description: "The ID of the template. Use this ID to create a schedule based\
            \ on the properties of this schedule template."
        status:
          type: "string"
          description: "The present status of the template. You cannot create or modify\
            \ a schedule using a template with an <code>INACTIVE</code> status.  For\
            \ implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:StatusEnum'>eBay\
            \ API documentation</a>"
        supportedConfigurations:
          type: "array"
          description: "An array of the configuration supported by this template."
          items:
            $ref: "#/components/schemas/SupportedConfiguration"
      description: "The type that defines the fields for a paginated result set of\
        \ available schedule templates. The response consists of 0 or more sequenced\
        \ <em> pages</em> where each page has 0 or more items."
    ServiceMetricsTask:
      type: "object"
      properties:
        completionDate:
          type: "string"
          description: "The timestamp when the customer service metrics task went\
            \ into the <code>COMPLETED</code> or <code>COMPLETED_WITH_ERROR</code>\
            \ state. This field is only returned if the status is one of the two completed\
            \ values. This state means that eBay has compiled the report for the seller\
            \ based on the seller’s filter criteria, and the seller can run a <strong>getResultFile</strong>\
            \ call to download the report."
        creationDate:
          type: "string"
          description: "The date the customer service metrics task was created."
        detailHref:
          type: "string"
          description: "The relative <strong>getCustomerServiceMetricTask</strong>\
            \ call URI path to retrieve the corresponding task."
        feedType:
          type: "string"
          description: "The feed type associated with the task."
        filterCriteria:
          description: "This container shows the criteria set for the report."
          $ref: "#/components/schemas/CustomerServiceMetricsFilterCriteria"
        schemaVersion:
          type: "string"
          description: "The schema version number of the file format. If omitted,\
            \ the default value is used. <p><b>Default value: </b><code>1.0</code><p>"
        status:
          type: "string"
          description: "An enumeration value that indicates the state of the task.\
            \ See <strong>FeedStatusEnum</strong> for values. For implementation help,\
            \ refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:FeedStatusEnum'>eBay\
            \ API documentation</a>"
        taskId:
          type: "string"
          description: "The unique eBay-assigned ID of the task."
      description: "This type defines customer service metric task response fields."
    StreamingOutput:
      type: "object"
      description: "File stream"
    SupportedConfiguration:
      type: "object"
      properties:
        defaultValue:
          type: "string"
          description: "The default value for the property. If a value is omitted\
            \ from the schedule and a default value is supplied, the default value\
            \ is used."
        property:
          type: "string"
          description: "Properties supported by the template. Properties can include\
            \ the following: <ul><li><b>scheduleStartDate:</b> The timestamp that\
            \ the report generation (subscription) begins. After this timestamp, the\
            \ schedule status becomes active until either the scheduleEndDate occurs\
            \ or the scheduleTemplate becomes inactive. Format: UTC <code>yyyy-MM-dd<strong>T</strong>HH<strong>Z</strong></code></li><li><b>scheduleEndDate:</b>\
            \ The timestamp that the report generation (subscription) ends. After\
            \ this date, the schedule status becomes INACTIVE. Format: UTC <code>yyyy-MM-dd<strong>T</strong>HH<strong>Z</strong></code></li><li><b>schemaVersion:</b>\
            \ The schema version of the schedule templates feedType. This field is\
            \ required if the feedType has a schema version.</li><li><b>preferredTriggerDayOfMonth:</b>\
            \ The preferred day of the month to trigger the schedule. </li><li><b>preferredTriggerDayOfWeek:</b>\
            \ The preferred day of the week to trigger the schedule. </li><li><b>preferredTriggerHour:</b>\
            \ The preferred two-digit hour of the day to trigger the schedule. Format:\
            \ UTC <code>hhZ</code></li><ul>"
        usage:
          type: "string"
          description: "Whether the specified property is REQUIRED or OPTIONAL. For\
            \ implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:ConfigurationsUsageEnum'>eBay\
            \ API documentation</a>"
      description: "An array that defines the configuration supported by this template.\
        \ This includes specified properties and usage (whether the property is REQUIRED\
        \ or OPTIONAL), and an optional default value."
    Task:
      type: "object"
      properties:
        completionDate:
          type: "string"
          description: "The timestamp when the task went into the <code>COMPLETED</code>\
            \ or <code>COMPLETED_WITH_ERROR</code> state. This state means that eBay\
            \ has compiled the report for the seller based on the seller’s filter\
            \ criteria, and the seller can run a <strong>getResultFile</strong> call\
            \ to download the report."
        creationDate:
          type: "string"
          description: "The date the task was created."
        detailHref:
          type: "string"
          description: "The path to the call URI used to retrieve the task. This field\
            \ points to the GetOrderTask URI if the task is for <code>LMS_ORDER_REPORT</code>\
            \ or will be null if this task is for <code>LMS_ORDER_ACK</code>."
        feedType:
          type: "string"
          description: "The feed type associated with the task."
        schemaVersion:
          type: "string"
          description: "The schema version number associated with the task."
        status:
          type: "string"
          description: "The enumeration value that indicates the state of the task\
            \ that was submitted in the request. See <strong>FeedStatusEnum</strong>\
            \ for information. <p>The values <code>COMPLETED </code>and<code> COMPLETED_WITH_ERROR</code>\
            \ indicate the Order Report file is ready to download.</p> For implementation\
            \ help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:FeedStatusEnum'>eBay\
            \ API documentation</a>"
        taskId:
          type: "string"
          description: "The ID of the task that was submitted in the request."
        uploadSummary:
          description: "This container provides summary information on an upload feed\
            \ (not applicable for download feed types)."
          $ref: "#/components/schemas/UploadSummary"
      description: "The type that defines the fields for the task details."
    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: "integer"
          description: "The total number of tasks that match the input criteria."
          format: "int32"
      description: "The type that defines the fields for a paginated result set of\
        \ tasks. The response consists of 0 or more sequenced <em> pages</em> where\
        \ each page has 0 or more items."
    UpdateUserScheduleRequest:
      type: "object"
      properties:
        preferredTriggerDayOfMonth:
          type: "integer"
          description: "The preferred day of the month to trigger the schedule. This\
            \ field can be used with <strong>preferredTriggerHour</strong> for monthly\
            \ schedules. The last day of the month is used for numbers larger than\
            \ the actual number of days in the month. <br /><br />This field is available\
            \ as specified by the template (<strong>scheduleTemplateId</strong>).\
            \ The template can specify this field as optional or required, and optionally\
            \ provides a default value. <br /><br /><b>Minimum: </b>1<b><br /><br\
            \ /><b>Maximum: </b>31"
          format: "int32"
        preferredTriggerDayOfWeek:
          type: "string"
          description: "The preferred day of the week to trigger the schedule. This\
            \ field can be used with <strong>preferredTriggerHour</strong> for weekly\
            \ schedules. <br /><br />This field is available as specified by the template\
            \ (<strong>scheduleTemplateId</strong>). The template can specify this\
            \ field as optional or required, and optionally provides a default value.\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:DayOfWeekEnum'>eBay\
            \ API documentation</a>"
        preferredTriggerHour:
          type: "string"
          description: "The preferred two-digit hour of the day to trigger the schedule.\
            \ <br /><br />This field is available as specified by the template (<strong>scheduleTemplateId</strong>).\
            \ The template can specify this field as optional or required, and optionally\
            \ provides a default value. <br /><br /><b>Format:</b> UTC <code>hhZ</code><br\
            \ /><br />For example, the following represents 11:00 am UTC:<code> 11Z</code><br\
            \ /><br /><b>Minimum: </b><code>00Z</code><br /><br /><b>Maximum:</b>\
            \ <code>23Z</code>"
        scheduleEndDate:
          type: "string"
          description: "The timestamp on which the schedule (report generation) ends.\
            \ After this date, the schedule status becomes <code>INACTIVE</code>.\
            \ <br /><br />Use this field, if available, to end the schedule in the\
            \ future. This value must be later than <strong>scheduleStartDate</strong>\
            \ (if supplied). This field is available as specified by the template\
            \ (<strong>scheduleTemplateId</strong>). The template can specify this\
            \ field as optional or required, and optionally provides a default value.<br\
            \ /><br /><b>Format:</b> UTC <code>yyyy-MM-dd<strong>T</strong>HH<strong>Z</strong></code><br\
            \ /><br />For example, the following represents UTC October 10, 2021 at\
            \ 10:00 AM:<br /><code> 2021-10-10T10Z</code>"
        scheduleName:
          type: "string"
          description: "The schedule name assigned by the user for the created schedule."
        scheduleStartDate:
          type: "string"
          description: "The timestamp to start generating the report. After this timestamp,\
            \ the schedule status becomes active until either the <strong>scheduleEndDate</strong>\
            \ occurs or the <strong>scheduleTemplateId</strong> becomes inactive.\
            \ <br /><br />Use this field, if available, to start the schedule in the\
            \ future but before the <strong>scheduleEndDate</strong> (if supplied).\
            \ This field is available as specified by the template <strong>(scheduleTemplateId)</strong>.\
            \  The template can specify this field as optional or required, and optionally\
            \ provides a default value.<br /><br /><b>Format:</b> UTC <code>yyyy-MM-dd<strong>T</strong>HH<strong>Z</strong></code><br\
            \ /><br />For example, the following represents a schedule start date\
            \ of UTC October 01, 2020 at 12:00 PM:<br /><code> 2020-01-01T12Z</code>"
        schemaVersion:
          type: "string"
          description: "The schema version of a schedule."
      description: "The type that defines the fields for a schedule update to a schedule\
        \ generated with the Feed API."
    UploadSummary:
      type: "object"
      properties:
        failureCount:
          type: "integer"
          description: "The number of records, such as the number of listings created\
            \ or the number of pictures uploaded to a listing, that failed to process\
            \ during the upload feed. Check the response file and correct any issues\
            \ mentioned. If the feed fails before processing, no response file is\
            \ provided. In this case check the REST output response."
          format: "int32"
        successCount:
          type: "integer"
          description: "The number of records that were successfully processed during\
            \ the upload feed."
          format: "int32"
      description: "This container provides summary information on an upload feed\
        \ (not applicable for download feed types)."
    UserScheduleCollection:
      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 schedules to return per\
            \ page, from the result set. A result set is the complete set of schedules\
            \ 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.<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>getSchedules</strong>\
            \ calls to view all tasks matching the input criteria.</span></p></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."
        schedules:
          type: "array"
          description: "An array of the schedules on this page. An empty array is\
            \ returned if the filter criteria excludes all tasks."
          items:
            $ref: "#/components/schemas/UserScheduleResponse"
        total:
          type: "integer"
          description: "The total number of schedules that match the input criteria."
          format: "int32"
      description: "The type that defines the fields for a paginated result set of\
        \ user schedules. The response consists of 0 or more sequenced <em> pages</em>\
        \ where each page has 0 or more items."
    UserScheduleResponse:
      type: "object"
      properties:
        scheduleId:
          type: "string"
          description: "The ID of the schedule. This ID is generated when the schedule\
            \ was created by the <strong>createSchedule</strong> method."
        creationDate:
          type: "string"
          description: "The creation date of the schedule in hours based on the 24-hour\
            \ Coordinated Universal Time (UTC) clock."
        feedType:
          type: "string"
          description: "The <strong>feedType</strong> associated with the schedule."
        lastModifiedDate:
          type: "string"
          description: "The date the schedule was last modified."
        preferredTriggerDayOfMonth:
          type: "integer"
          description: "The preferred day of the month to trigger the schedule. This\
            \ field can be used with <strong>preferredTriggerHour</strong> for monthly\
            \ schedules. The last day of the month is used for numbers larger than\
            \ the number of days in the month."
          format: "int32"
        preferredTriggerDayOfWeek:
          type: "string"
          description: "The preferred day of the week to trigger the schedule. This\
            \ field can be used with <strong>preferredTriggerHour</strong> for weekly\
            \ schedules. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:DayOfWeekEnum'>eBay\
            \ API documentation</a>"
        preferredTriggerHour:
          type: "string"
          description: "The preferred two-digit hour of the day to trigger the schedule.\
            \ <br /><br /><b>Format:</b> UTC <code>hhZ</code><br /><br />For example,\
            \ the following represents 11:00 am UTC:<br /><br /><code>11Z</code><br\
            \ /><br />"
        scheduleEndDate:
          type: "string"
          description: "The timestamp on which the report generation (subscription)\
            \ ends. After this date, the schedule status becomes <code>INACTIVE</code>."
        scheduleName:
          type: "string"
          description: "The schedule name assigned by the user for the created schedule.\
            \ Users assign this name for their reference."
        scheduleStartDate:
          type: "string"
          description: "The timestamp that indicates the start of the report generation."
        scheduleTemplateId:
          type: "string"
          description: "The ID of the template used to create this schedule."
        schemaVersion:
          type: "string"
          description: "The schema version of the feedType for the schedule."
        status:
          type: "string"
          description: "The enumeration value that indicates the state of the schedule.\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:StatusEnum'>eBay\
            \ API documentation</a>"
        statusReason:
          type: "string"
          description: "The reason the schedule is inactive. For implementation help,\
            \ refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:StatusReasonEnum'>eBay\
            \ API documentation</a>"
      description: "The type that defines the fields for a paginated result set of\
        \ available schedules. The response consists of 0 or more sequenced <em> pages</em>\
        \ where each page has 0 or more items."
  securitySchemes:
    api_auth:
      type: "oauth2"
      description: "The security definitions for this API. Please check individual\
        \ operations for applicable scopes."
      flows:
        authorizationCode:
          authorizationUrl: "https://auth.ebay.com/oauth2/authorize"
          tokenUrl: "https://api.ebay.com/identity/v1/oauth2/token"
          scopes:
            https://api.ebay.com/oauth/api_scope/sell.fulfillment: "View and manage\
              \ your order fulfillments"
            https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly: " This\
              \ scope would allow signed in user to read catalog data."
            https://api.ebay.com/oauth/api_scope/sell.inventory: "View and manage\
              \ your inventory and offers"
            https://api.ebay.com/oauth/api_scope/sell.marketing: "View and manage\
              \ your eBay marketing activities, such as ad campaigns and listing promotions"
            https://api.ebay.com/oauth/api_scope/sell.analytics.readonly: "View your\
              \ selling analytics data, such as performance reports"