openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 135 kB

JSON

{"openapi":"3.0.0","servers":[{"description":"Production","url":"https://api.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/feed/v1"}}}],"info":{"contact":{"name":"eBay Inc,","x-twitter":"ebay"},"description":"The Feed API lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.","license":{"name":"eBay API License Agreement","url":"https://go.developer.ebay.com/api-license-agreement"},"title":"Feed API","version":"v1.3.1","x-apisguru-categories":["ecommerce"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://twitter.com/ebay/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://developer.ebay.com/api-docs/master/sell/feed/openapi/3/sell_feed_v1_oas3.json","version":"3.0"}],"x-providerName":"ebay.com","x-serviceName":"sell-feed"},"paths":{"/customer_service_metric_task":{"get":{"description":"Use this method to return an array of customer service metric tasks. You can limit the tasks returned by specifying a date range. Note: You can pass in either the <code>look_back_days </code>or<code> date_range</code>, but not both.","operationId":"getCustomerServiceMetricTasks","parameters":[{"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.Format: UTCFor example, tasks within a range: <code>yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ </code>Tasks created on March 8, 2020<code>2020-03-08T00:00.00.000Z..2020-03-09T00:00:00.000Z</code>Maximum: 90 days","in":"query","name":"date_range","required":false,"schema":{"type":"string"}},{"description":"The feed type associated with the task. The only presently supported value is <code>CUSTOMER_SERVICE_METRICS_REPORT</code>.","in":"query","name":"feed_type","required":false,"schema":{"type":"string"}},{"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. For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.If this parameter is omitted, the default value is used. Note:This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.Default: 10 Maximum: 500","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"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. Default value: 7Range: 1-90 (inclusive)","in":"query","name":"look_back_days","required":false,"schema":{"type":"string"}},{"description":"The number of customer service metric tasks to skip in the result set before returning the first task in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of <code>0</code> and a limit 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 offset is <code>10</code> and limit is <code>20</code>, the first page of the response contains items 11-30 from the complete result set. Default: 0","in":"query","name":"offset","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerServiceMetricTaskCollection"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"},"160005":{"category":"REQUEST","description":"Both 'feed_type' and 'schedule_id' were provided. Please remove one of them.","domain":"API_FEED"},"160006":{"category":"REQUEST","description":"The 'feed_type' {feedTypeValue} is invalid.","domain":"API_FEED"},"160008":{"category":"REQUEST","description":"Both 'look_back_days' and 'date_range' were provided. Please remove one of them.","domain":"API_FEED"},"160009":{"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.","domain":"API_FEED"},"160010":{"category":"REQUEST","description":"The 'date_range' must be less than or equal to 90 days.","domain":"API_FEED"},"160011":{"category":"REQUEST","description":"The 'look_back_days' value must be greater than zero and less than or equal to 90.","domain":"API_FEED"},"160012":{"category":"REQUEST","description":"The 'limit' value must be greater than zero and less than or equal to 500.","domain":"API_FEED"},"160013":{"category":"REQUEST","description":"The 'offset' value cannot be less than zero.","domain":"API_FEED"},"160029":{"category":"REQUEST","description":"The 'offset' value must be a multiple of the 'limit' value.","domain":"API_FEED"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"]}],"tags":["customer_service_metric_task"]},"post":{"description":"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 feedType and filterCriteria including both evaluationMarketplaceId and customerServiceMetricType for the report. The method returns the location response header containing the call URI to use with getCustomerServiceMetricTask to retrieve status and details on the task.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.Note: Before calling this API, retrieve the summary of the seller's performance and rating for the customer service metric by calling getCustomerServiceMetric (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 customerServiceMetricType and evaluationMarketplaceId that are without evaluation.","operationId":"createCustomerServiceMetricTask","parameters":[{"description":"Use this header to specify the natural language in which the authenticated user desires the response.","in":"header","name":"accept-language","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceMetricsTaskRequest","description":"Request payload containing version, feedType, and optional filterCriteria."}}},"description":"Request payload containing version, feedType, and optional filterCriteria.","required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"160017":{"category":"REQUEST","description":"The 'feedType' is missing or invalid.","domain":"API_FEED"},"160018":{"category":"REQUEST","description":"The 'schemaVersion' is invalid.","domain":"API_FEED"},"160024":{"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.","domain":"API_FEED"},"160025":{"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.","domain":"API_FEED"},"164500":{"category":"REQUEST","description":"The 'customerServiceMetricType' in 'filterCriteria' is not a valid type. Valid metric types are ITEM_NOT_AS_DESCRIBED or ITEM_NOT_RECEIVED.","domain":"API_FEED"},"164501":{"category":"REQUEST","description":"The 'evaluationMarketplaceId' in 'filterCriteria' is not a supported marketplace. For a complete list of the supported marketplace IDs, see the documentation.","domain":"API_FEED"},"164502":{"category":"REQUEST","description":"The 'listingCategories' in 'filterCriteria' or some part of the 'listingCategories' is invalid. {additionalInfo}","domain":"API_FEED"},"164503":{"category":"REQUEST","description":"The 'shippingRegions' in 'filterCriteria' or some part of the 'shippingRegions' is invalid. {additionalInfo}","domain":"API_FEED"},"164504":{"category":"REQUEST","description":"The Accept-Language header is missing or invalid.","domain":"API_FEED"},"164505":{"category":"REQUEST","description":"The 'filterCriteria' is missing or invalid.","domain":"API_FEED"},"164506":{"category":"REQUEST","description":"The 'listingCategories' is not applicable to the 'customerServiceMetricType' {customerServiceMetricType} in 'filterCriteria'.","domain":"API_FEED"},"164507":{"category":"REQUEST","description":"The 'shippingRegions' is not applicable to the 'customerServiceMetricType' {customerServiceMetricType} in 'filterCriteria'.","domain":"API_FEED"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"]}],"tags":["customer_service_metric_task"]}},"/customer_service_metric_task/{task_id}":{"get":{"description":"Use this method to retrieve customer service metric task details for the specified task. The input is task_id.","operationId":"getCustomerServiceMetricTask","parameters":[{"description":"Use this path parameter to specify the task ID value for the customer service metric task to retrieve.","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceMetricsTask"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"},"160003":{"category":"REQUEST","description":"Task {taskID} does not exist.","domain":"API_FEED"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"]}],"tags":["customer_service_metric_task"]}},"/inventory_task":{"get":{"description":"This method searches for multiple tasks of a specific feed type, and includes date filters and pagination.","operationId":"getInventoryTasks","parameters":[{"description":"The feed type associated with the inventory task. Either feed_type or schedule_id is required. Do not use with the schedule_id parameter. Presently, only one feed type is available:<ul><li><code>LMS_ACTIVE_INVENTORY_REPORT</code></li></ul>","in":"query","name":"feed_type","required":false,"schema":{"type":"string"}},{"description":"The ID of the schedule for which to retrieve the latest result file. This ID is generated when the schedule was created by the createSchedule method. Schedules apply to downloaded reports (<code>LMS_ACTIVE_INVENTORY_REPORT</code>). Either schedule_id or feed_type is required. Do not use with the feed_type parameter.","in":"query","name":"schedule_id","required":false,"schema":{"type":"string"}},{"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. Default: 7 Range: 1-90 (inclusive)","in":"query","name":"look_back_days","required":false,"schema":{"type":"string"}},{"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. Note: Maximum date range window size is 90 days. Valid Format (UTC): <code>yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ</code> For example: Tasks created on March 31, 2021 <code>2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z</code> ","in":"query","name":"date_range","required":false,"schema":{"type":"string"}},{"description":"The maximum number of tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output. Note: This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.If this parameter is omitted, the default value is used. Default: 10 Maximum: 500","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"The number of tasks to skip in the result set before returning the first task in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of <code>0</code> and a limit 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 offset is <code>10</code> and limit 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. Default: 0","in":"query","name":"offset","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryTaskCollection"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"160004":{"category":"REQUEST","description":"You must submit either a 'feed_type' or 'schedule_id'.","domain":"API_FEED"},"160005":{"category":"REQUEST","description":"Both 'feed_type' and 'schedule_id' were provided. Please remove one of them.","domain":"API_FEED"},"160006":{"category":"REQUEST","description":"The 'feed_type' {feedTypeValue} is invalid.","domain":"API_FEED"},"160007":{"category":"REQUEST","description":"The 'schedule_id' {scheduleID} is invalid.","domain":"API_FEED"},"160008":{"category":"REQUEST","description":"Both 'look_back_days' and 'date_range' were provided. Please remove one of them.","domain":"API_FEED"},"160009":{"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.","domain":"API_FEED"},"160010":{"category":"REQUEST","description":"The 'date_range' must be less than or equal to 90 days.","domain":"API_FEED"},"160011":{"category":"REQUEST","description":"The 'look_back_days' value must be greater than zero and less than or equal to 90.","domain":"API_FEED"},"160012":{"category":"REQUEST","description":"The 'limit' value must be greater than zero and less than or equal to 500.","domain":"API_FEED"},"160013":{"category":"REQUEST","description":"The 'offset' value cannot be less than zero.","domain":"API_FEED"},"160029":{"category":"REQUEST","description":"The 'offset' value must be a multiple of the 'limit' value.","domain":"API_FEED"}}}},"403":{"description":"Forbidden","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.inventory"]}],"tags":["inventory_task"]},"post":{"description":"This method creates an inventory-related download task for a specified feed type with optional filter criteria. When using this method, specify the feedType. This method returns the location response header containing the getInventoryTask 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. To retrieve the status of the task, use the getInventoryTask method to retrieve a single task ID or the getInventoryTasks method to retrieve multiple task IDs. Note: The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.Presently, this method supports Active Inventory Report. The ActiveInventoryReport 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","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInventoryTaskRequest","description":"The request payload containing the version, feedType, and optional filterCriteria."}}},"description":"The request payload containing the version, feedType, and optional filterCriteria.","required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"160017":{"category":"REQUEST","description":"The 'feedType' is missing or invalid.","domain":"API_FEED"},"160018":{"category":"REQUEST","description":"The 'schemaVersion' is invalid.","domain":"API_FEED"},"160019":{"category":"REQUEST","description":"The 'filterCriteria' is invalid. {additionalInfo}","domain":"API_FEED"},"160027":{"category":"REQUEST","description":"The X-EBAY-C-MARKETPLACE-ID header is missing or invalid.","domain":"API_FEED"},"160030":{"category":"REQUEST","description":"This resource is not applicable for the feed type {feedTypeValue}. For more information, see the documentation for this API.","domain":"API_FEED"}}}},"403":{"description":"Forbidden","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"},"160022":{"category":"REQUEST","description":"You are not allowed to access this resource. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}},"409":{"description":"Conflict","x-response-codes":{"errors":{"160024":{"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.","domain":"API_FEED"},"160025":{"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.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.inventory"]}],"tags":["inventory_task"]}},"/inventory_task/{task_id}":{"get":{"description":"This method retrieves the task details and status of the specified inventory-related task. The input is task_id.","operationId":"getInventoryTask","parameters":[{"description":"The ID of the task. This ID was generated when the task was created by the createInventoryTask method","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryTask"}}},"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"}}}},"404":{"description":"Not Found","x-response-codes":{"errors":{"160003":{"category":"REQUEST","description":"Task {taskID} does not exist.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.inventory"]}],"tags":["inventory_task"]}},"/order_task":{"get":{"description":"This method returns the details and status for an array of order tasks based on a specified feed_type or schedule_id. Specifying both feed_type and schedule_id results in an error. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type. If specifying the feed_type, limit which order tasks are returned by specifying filters such as the creation date range or period of time using look_back_days. If specifying a schedule_id, the schedule template (that the schedule_id is based on) determines which order tasks are returned (see schedule_id for additional information). Each schedule_id applies to one feed_type.","operationId":"getOrderTasks","parameters":[{"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 look_back_days parameter. Format: UTC For example: Tasks within a range <code>yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ </code> Tasks created on September 8, 2019 <code>2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z</code> ","in":"query","name":"date_range","required":false,"schema":{"type":"string"}},{"description":"The feed type associated with the task. The only presently supported value is <code>LMS_ORDER_REPORT</code>. Do not use with the schedule_id parameter. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.","in":"query","name":"feed_type","required":false,"schema":{"type":"string"}},{"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 offset parameter to control the pagination of the output. Note: This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.For example, if offset is set to 10 and limit is set to 10, the call retrieves order tasks 11 thru 20 from the result set.If this parameter is omitted, the default value is used.Default: 10 Maximum: 500","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"The number of previous days in which to search for tasks. Do not use with the date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used. Default: 7 Range: 1-90 (inclusive) ","in":"query","name":"look_back_days","required":false,"schema":{"type":"string"}},{"description":"The number of order tasks to skip in the result set before returning the first order in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of <code>0</code> and a limit 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 offset is <code>10</code> and limit 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. Default: 0","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"The schedule ID associated with the order task. A schedule periodically generates a report for the feed type specified by the schedule template (see scheduleTemplateId in createSchedule). Do not use with the feed_type parameter. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.","in":"query","name":"schedule_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderTaskCollection"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"160004":{"category":"REQUEST","description":"You must submit either a 'feed_type' or 'schedule_id'.","domain":"API_FEED"},"160005":{"category":"REQUEST","description":"Both 'feed_type' and 'schedule_id' were provided. Please remove one of them.","domain":"API_FEED"},"160006":{"category":"REQUEST","description":"The 'feed_type' {feedTypeValue} is invalid.","domain":"API_FEED"},"160007":{"category":"REQUEST","description":"The 'schedule_id' {scheduleID} is invalid.","domain":"API_FEED"},"160008":{"category":"REQUEST","description":"Both 'look_back_days' and 'date_range' were provided. Please remove one of them.","domain":"API_FEED"},"160009":{"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.","domain":"API_FEED"},"160010":{"category":"REQUEST","description":"The 'date_range' must be less than or equal to 90 days.","domain":"API_FEED"},"160011":{"category":"REQUEST","description":"The 'look_back_days' value must be greater than zero and less than or equal to 90.","domain":"API_FEED"},"160012":{"category":"REQUEST","description":"The 'limit' value must be greater than zero and less than or equal to 500.","domain":"API_FEED"},"160013":{"category":"REQUEST","description":"The 'offset' value cannot be less than zero.","domain":"API_FEED"},"160029":{"category":"REQUEST","description":"The 'offset' value must be a multiple of the 'limit' value.","domain":"API_FEED"}}}},"403":{"description":"Forbidden","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.fulfillment"]}],"tags":["order_task"]},"post":{"description":"This method creates an order download task with filter criteria for the order report. When using this method, specify the feedType, schemaVersion, and filterCriteria for the report. The method returns the location 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. To retrieve the status of the task, use the getOrderTask method to retrieve a single task ID or the getOrderTasks method to retrieve multiple order task IDs. Note: The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.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> For details about how this method is used, see <a href=\"/api-docs/sell/static/feed/general-feed-tasks.html\">General feed types</a> in the Selling Integration Guide. Note: At this time, the createOrderTask method only supports order creation date filters and not modified order date filters. Do not include the modifiedDateRange filter in your request payload.","operationId":"createOrderTask","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderTaskRequest","description":"description not needed"}}},"description":"description not needed","required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"160017":{"category":"REQUEST","description":"The 'feedType' is missing or invalid.","domain":"API_FEED"},"160018":{"category":"REQUEST","description":"The 'schemaVersion' is invalid.","domain":"API_FEED"},"160019":{"category":"REQUEST","description":"The 'filterCriteria' is invalid. {additionalInfo}","domain":"API_FEED"},"160027":{"category":"REQUEST","description":"The X-EBAY-C-MARKETPLACE-ID header is missing or invalid.","domain":"API_FEED"},"160030":{"category":"REQUEST","description":"This resource is not applicable for the feed type {feedTypeValue}. For more information, see the documentation for this API.","domain":"API_FEED"}}}},"403":{"description":"Forbidden","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"},"160022":{"category":"REQUEST","description":"You are not allowed to access this resource. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}},"409":{"description":"Conflict","x-response-codes":{"errors":{"160024":{"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.","domain":"API_FEED"},"160025":{"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.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.fulfillment"]}],"tags":["order_task"]}},"/order_task/{task_id}":{"get":{"description":"This method retrieves the task details and status of the specified task. The input is task_id. 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. ","operationId":"getOrderTask","parameters":[{"description":"The ID of the task. This ID is generated when the task was created by the createOrderTask method.","in":"path","name":"task_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderTask"}}},"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"}}}},"404":{"description":"Not Found","x-response-codes":{"errors":{"160003":{"category":"REQUEST","description":"Task {taskID} does not exist.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.fulfillment"]}],"tags":["order_task"]}},"/schedule":{"get":{"description":"This method retrieves an array containing the details and status of all schedules based on the specified feed_type. Use this method to find a schedule if you do not know the schedule_id.","operationId":"getSchedules","parameters":[{"description":"The feedType associated with the schedule.","in":"query","name":"feed_type","required":true,"schema":{"type":"string"}},{"description":"The maximum number of schedules that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output. Note: This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>.For example, if offset is set to 10 and limit is set to 10, the call retrieves schedules 11 thru 20 from the result set.If this parameter is omitted, the default value is used. Default: 10 Maximum: 500","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"The number of schedules to skip in the result set before returning the first schedule in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of <code>0</code> and a limit 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 offset is <code>10</code> and limit 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. Default: 0","in":"query","name":"offset","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserScheduleCollection"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"160012":{"category":"REQUEST","description":"The 'limit' value must be greater than zero and less than or equal to 500.","domain":"API_FEED"},"160013":{"category":"REQUEST","description":"The 'offset' value cannot be less than zero.","domain":"API_FEED"},"160017":{"category":"REQUEST","description":"The 'feedType' is missing or invalid.","domain":"API_FEED"},"160029":{"category":"REQUEST","description":"The 'offset' value must be a multiple of the 'limit' value.","domain":"API_FEED"}}}},"403":{"description":"Forbidden","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"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"]}],"tags":["schedule"]},"post":{"description":"This method creates a schedule, which is a subscription to the specified schedule template. A schedule periodically generates a report for the feedType specified by the template. Specify the same feedType as the feedType 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. Note: Make sure to include all fields required by the schedule template (scheduleTemplateId). Call the getScheduleTemplate method (or the getScheduleTemplates 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.A successful call returns the location response header containing the getSchedule 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. To retrieve the details of the create schedule task, use the getSchedule method for a single schedule ID or the getSchedules method to retrieve all schedule details for the specified feed_type. The number of schedules for each feedType is limited. Error code 160031 is returned when you have reached this maximum. Note: 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.","operationId":"createSchedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserScheduleRequest","description":"In the request payload: feedType and scheduleTemplateId are required; scheduleName is optional; preferredTriggerHour, preferredTriggerDayOfWeek, preferredTriggerDayOfMonth, scheduleStartDate, scheduleEndDate, and schemaVersion are conditional."}}},"description":"In the request payload: feedType and scheduleTemplateId are required; scheduleName is optional; preferredTriggerHour, preferredTriggerDayOfWeek, preferredTriggerDayOfMonth, scheduleStartDate, scheduleEndDate, and schemaVersion are conditional.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Created","headers":{"Location":{"schema":{"description":"The URL of the schedule, which includes the id.","type":"string"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"160017":{"category":"REQUEST","description":"The 'feedType' is missing or invalid.","domain":"API_FEED"},"160032":{"category":"REQUEST","description":"The 'scheduleTemplateId' is invalid. Call the getScheduleTemplates method to get the available schedule templates.","domain":"API_FEED"},"160033":{"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.","domain":"API_FEED"},"160034":{"category":"REQUEST","description":"The '{fieldName}' is invalid, missing, or not allowed.","domain":"API_FEED"},"160036":{"category":"REQUEST","description":"The '{fieldName}' is in the past.","domain":"API_FEED"},"160037":{"category":"REQUEST","description":"The 'scheduleEndDate' is before 'scheduleStartDate'.","domain":"API_FEED"}}}},"403":{"description":"Forbidden","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"},"160022":{"category":"REQUEST","description":"You are not allowed to access this resource. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}},"409":{"description":"Conflict","x-response-codes":{"errors":{"160031":{"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.","domain":"API_FEED"},"160035":{"category":"BUSINESS","description":"Duplicate schedule (a matching schedule already exists). Use the getSchedules method to see the existing schedules.","domain":"API_FEED"},"160040":{"category":"BUSINESS","description":"The 'scheduleTemplateId' is inactive. You cannot create or modify a schedule with an inactive 'scheduleTemplateId'.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"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"]}],"tags":["schedule"]}},"/schedule/{schedule_id}":{"delete":{"description":"This method deletes an existing schedule. Specify the schedule to delete using the schedule_id path parameter.","operationId":"deleteSchedule","parameters":[{"description":"The schedule_id of the schedule to delete. This ID was generated when the task was created. If you do not know the schedule_id, use the getSchedules method to return all schedules based on a specified feed_type and find the schedule_id of the schedule to delete.","in":"path","name":"schedule_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","x-response-codes":{"errors":{"160038":{"category":"REQUEST","description":"The schedule id {schedule_id} does not exist.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"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"]}],"tags":["schedule"]},"get":{"description":"This method retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve using the schedule_id. Use the getSchedules method to find a schedule if you do not know the schedule_id.","operationId":"getSchedule","parameters":[{"description":"The ID of the schedule for which to retrieve the details. This ID is generated when the schedule was created by the createSchedule method.","in":"path","name":"schedule_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserScheduleResponse"}}},"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden","x-response-codes":{"errors":{"160002":{"category":"REQUEST","description":"The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.","domain":"API_FEED"}}}},"404":{"description":"Not Found","x-response-codes":{"errors":{"160038":{"category":"REQUEST","description":"The schedule id {schedule_id} does not exist.","domain":"API_FEED"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"160001":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.","domain":"API_FEED"}}}}},"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"]}],"tags":["schedule"]},"put":{"description":"This method updates an existing schedule. Specify the schedule to update using the schedule_id path parameter. If the schedule template has changed after the schedule was created or updated, the input will be validated using the changed template. Note: Make sure to include all fields required by the schedule template (scheduleTemplateId). Call the getScheduleTemplate method (or the getScheduleTemplates method), to find out which fields are required or optional. If you do not know the scheduleTemplateId, call the getSchedule method to find out.","operationId":"updateSchedule","parameters":[{"description":"The ID of the schedule to update. This ID is generated when the schedule was created by the createSchedule method.","in":"path","name":"schedule_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schem