{"files":{"SKILL.md":"---\nname: feed-api\ndescription: \"Feed API skill. Use when working with Feed for order_task, inventory_task, schedule. Covers 23 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Feed API\nAPI version: v1.3.1\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://api.ebay.com/sell/feed/v1\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /order_task -- 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.\n3. POST /order_task -- create first order_task\n\n## Endpoints\n23 endpoints across 6 groups. See references/api-spec.lap for full details.\n\n### Order_task\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /order_task | 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. |\n| POST | /order_task | 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:https://api.ebay.com/oauth/api_scope/sell.fulfillment: LMS_ORDER_REPORT For details about how this method is used, see General feed types 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. |\n| GET | /order_task/{task_id} | 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 Working with Order Feeds in the Selling Integration Guide. |\n\n### Inventory_task\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /inventory_task | This method searches for multiple tasks of a specific feed type, and includes date filters and pagination. |\n| POST | /inventory_task | 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. |\n| GET | /inventory_task/{task_id} | This method retrieves the task details and status of the specified inventory-related task. The input is task_id. |\n\n### Schedule\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /schedule | 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. |\n| POST | /schedule | 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. |\n| GET | /schedule/{schedule_id} | 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. |\n| PUT | /schedule/{schedule_id} | 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. |\n| DELETE | /schedule/{schedule_id} | This method deletes an existing schedule. Specify the schedule to delete using the schedule_id path parameter. |\n| GET | /schedule/{schedule_id}/download_result_file | 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 schedule_id path parameter to download its last generated file. |\n\n### Schedule_template\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /schedule_template/{schedule_template_id} | This method retrieves the details of the specified template. Specify the template to retrieve using the schedule_template_id path parameter. Use the getScheduleTemplates method to find a schedule template if you do not know the schedule_template_id. |\n| GET | /schedule_template | This method retrieves an array containing the details and status of all schedule templates based on the specified feed_type. Use this method to find a schedule template if you do not know the schedule_template_id. |\n\n### Task\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /task | This method returns the details and status for an array of 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 tasks are returned by specifying filters, such as the creation date range or period of time using look_back_days. Also, by specifying the feed_type, both on-demand and scheduled reports are returned.If specifying a schedule_id, the schedule template (that the schedule ID is based on) determines which tasks are returned (see schedule_id for additional information). Each scheduledId applies to one feed_type. |\n| POST | /task | This method creates an upload task or a download task without filter criteria. When using this method, specify the  feedType and the feed file  schemaVersion. The feed type specified sets the task as a download or an upload task.  For details about the upload and download flows, see Working with Order Feeds in the Selling Integration Guide. 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 scopes and their corresponding feed types:https://api.ebay.com/oauth/api_scope/sell.inventory: See LMS FeedTypeshttps://api.ebay.com/oauth/api_scope/sell.fulfillment: LMS_ORDER_ACK (specify for upload tasks). Also see LMS FeedTypeshttps://api.ebay.com/oauth/api_scope/sell.marketing: None*https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly: None** Reserved for future release |\n| GET | /task/{task_id}/download_input_file | This method downloads the file previously uploaded using uploadFile. Specify the task_id from the uploadFile call. Note: With respect to LMS, this method applies to all feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT. See LMS API Feeds in the Selling Integration Guide. |\n| GET | /task/{task_id}/download_result_file | 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). For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide. Note: 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. |\n| GET | /task/{task_id} | This method retrieves the details and status of the specified task. The input is task_id. For details of how this method is used, see Working with Order Feeds in the Selling Integration Guide. |\n| POST | /task/{task_id}/upload_file | 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. 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  getTask with the task ID or  getTasks to determine the status of a report. The status flow is QUEUED > IN_PROCESS > COMPLETED or COMPLETED_WITH_ERROR. When the status is COMPLETED or COMPLETED_WITH_ERROR, 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. For details of how this method is used in the upload flow, see Working with Order Feeds in the Selling Integration Guide. This call does not have a JSON Request payload but uploads the file as form-data. For example:  fileName: \"AddFixedPriceItem_Macbook.xml\"  name: \"file\"  type: \"form-data\"  file: @\"/C:/Users/.../AddFixedPriceItem_Macbook.7z\"See Samples for information.Note: This method applies to all Seller Hub feed types, and to all LMS feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT. Note: You must use a Content-Type header with its value set to \"multipart/form-data\". See Samples for information.Note: For LMS feed types, upload a regular XML file or an XML file in zipped format (both formats are allowed). |\n\n### Customer_service_metric_task\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /customer_service_metric_task | 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 look_back_days or date_range, but not both. |\n| POST | /customer_service_metric_task | 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 getCustomerServiceMetric 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 Analytics API). 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. |\n| GET | /customer_service_metric_task/{task_id} | Use this method to retrieve customer service metric task details for the specified task. The input is task_id. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all order_task?\" -> GET /order_task\n- \"Create a order_task?\" -> POST /order_task\n- \"Get order_task details?\" -> GET /order_task/{task_id}\n- \"List all inventory_task?\" -> GET /inventory_task\n- \"Create a inventory_task?\" -> POST /inventory_task\n- \"Get inventory_task details?\" -> GET /inventory_task/{task_id}\n- \"List all schedule?\" -> GET /schedule\n- \"Create a schedule?\" -> POST /schedule\n- \"Get schedule details?\" -> GET /schedule/{schedule_id}\n- \"Update a schedule?\" -> PUT /schedule/{schedule_id}\n- \"Delete a schedule?\" -> DELETE /schedule/{schedule_id}\n- \"List all download_result_file?\" -> GET /schedule/{schedule_id}/download_result_file\n- \"Get schedule_template details?\" -> GET /schedule_template/{schedule_template_id}\n- \"List all schedule_template?\" -> GET /schedule_template\n- \"List all task?\" -> GET /task\n- \"Create a task?\" -> POST /task\n- \"List all download_input_file?\" -> GET /task/{task_id}/download_input_file\n- \"Get task details?\" -> GET /task/{task_id}\n- \"Create a upload_file?\" -> POST /task/{task_id}/upload_file\n- \"List all customer_service_metric_task?\" -> GET /customer_service_metric_task\n- \"Create a customer_service_metric_task?\" -> POST /customer_service_metric_task\n- \"Get customer_service_metric_task details?\" -> GET /customer_service_metric_task/{task_id}\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Feed API\n@base https://api.ebay.com/sell/feed/v1\n@version v1.3.1\n@auth OAuth2\n@endpoints 23\n@hint download_for_search\n@toc order_task(3), inventory_task(3), schedule(6), schedule_template(2), task(6), customer_service_metric_task(3)\n\n@group order_task\n@endpoint GET /order_task\n@desc 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.\n@optional {date_range: str # 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   yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ   Tasks created on September 8, 2019 2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z, feed_type: str # The feed type associated with the order tasks being retrieved. The only presently supported value is LMS_ORDER_REPORTSee Report download feed types for more information.Note: 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., limit: str # 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 0.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, look_back_days: str # 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), offset: str # 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 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, 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, schedule_id: str # The schedule ID associated with the order tasks being retrieved. A schedule periodically generates a report, and these schedules can be created with the createSchedule method.Note: 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.Use the getSchedules method to retrieve schedule IDs.}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), prev: str, tasks: [map], total: int(int32)} # Success\n@errors {400: Bad Request, 403: Forbidden, 500: Internal Server Error}\n\n@endpoint POST /order_task\n@desc 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:https://api.ebay.com/oauth/api_scope/sell.fulfillment: LMS_ORDER_REPORT For details about how this method is used, see General feed types 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.\n@required {Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {feedType: str # The feed type associated with the task. The only presently supported value is LMS_ORDER_REPORT.See Report download feed types for more information., filterCriteria: map{creationDateRange: map, modifiedDateRange: map, orderStatus: str} # The type that defines the fields for the order filters., schemaVersion: str # The schema version of the LMS OrderReport. For the LMS_ORDER_REPORT feed type, see the OrderReport reference page to see the present schema version. The  schemaVersion value is the version number shown at the top of the  OrderReport page. Restriction:  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'.}\n@returns(202) Accepted\n@errors {400: Bad Request, 403: Forbidden, 409: Conflict, 500: Internal Server Error}\n\n@endpoint GET /order_task/{task_id}\n@desc 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 Working with Order Feeds in the Selling Integration Guide.\n@required {task_id: str # This path parameter is the unique identifier of the order task being retrieved.Use the getOrderTasks method to retrieve order task IDs.}\n@returns(200) {completionDate: str, creationDate: str, detailHref: str, feedType: str, filterCriteria: map{creationDateRange: map{from: str, to: str}, modifiedDateRange: map{from: str, to: str}, orderStatus: str}, schemaVersion: str, status: str, taskId: str, uploadSummary: map{failureCount: int(int32), successCount: int(int32)}} # Success\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group inventory_task\n@endpoint GET /inventory_task\n@desc This method searches for multiple tasks of a specific feed type, and includes date filters and pagination.\n@optional {feed_type: str # The feed type associated with the inventory tasks being retrieved. Presently, only one feed type is available:LMS_ACTIVE_INVENTORY_REPORTSee Report value feed types for more information., schedule_id: str # Note: Schedule functionality for ActiveInventoryReport is currently unavailable, so this field is not usable., look_back_days: str # 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), date_range: str # 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): yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZFor example: Tasks created on March 31, 2021 2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z, limit: str # 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 0.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, offset: str # 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 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, 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}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), prev: str, tasks: [map], total: int(int32)} # Success\n@errors {400: Bad Request, 403: Forbidden, 500: Internal Server Error}\n\n@endpoint POST /inventory_task\n@desc 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.\n@required {Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {feedType: str # The feed type associated with the inventory task you are about to create. Presently, only one feed type is available:LMS_ACTIVE_INVENTORY_REPORTSee Report download feed types for more information., filterCriteria: map{listingFormat: str} # This container is used to set the filter criteria for the ActiveInventoryReport. A seller can create an ActiveInventoryReport for a single listing format., schemaVersion: str # The version number of the inventory task to use for the feedType.Note: This field must have a value of 1.0.}\n@returns(202) Accepted\n@errors {400: Bad Request, 403: Forbidden, 409: Conflict, 500: Internal Server Error}\n\n@endpoint GET /inventory_task/{task_id}\n@desc This method retrieves the task details and status of the specified inventory-related task. The input is task_id.\n@required {task_id: str # This path parameter is the unique identifier of the inventory task being retrieved. Use the getInventoryTasks method to retrieve inventory task IDs.}\n@returns(200) {taskId: str, status: str, feedType: str, creationDate: str, completionDate: str, schemaVersion: str, detailHref: str, uploadSummary: map{failureCount: int(int32), successCount: int(int32)}, filterCriteria: map{listingFormat: str}} # Success\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group schedule\n@endpoint GET /schedule\n@desc 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.\n@required {feed_type: str # The feed type associated with the schedules being retrieved.Note: Schedules are currently only available for LMS_ORDER_REPORT.}\n@optional {limit: str # 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 0.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, offset: str # 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 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, 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}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), prev: str, schedules: [map], total: int(int32)} # Success\n@errors {400: Bad Request, 403: Forbidden, 500: Internal Server Error}\n\n@endpoint POST /schedule\n@desc 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.\n@required {Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {feedType: str # The name of the feed type for the created schedule. Use the getScheduleTemplates method to retrieve the feed type of a schedule template.Note: Schedules are currently only available for LMS_ORDER_REPORT., preferredTriggerDayOfMonth: int(int32) # The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the actual number of days in the month. This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.Minimum: 1Maximum: 31, preferredTriggerDayOfWeek: str # The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules. This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value. For implementation help, refer to eBay API documentation, preferredTriggerHour: str # The preferred two-digit hour of the day to trigger the schedule. This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.Format: UTC hhZFor example, the following represents 11:00 am UTC: 11Z, scheduleEndDate: str # The timestamp on which the report generation (subscription) ends. After this date, the schedule status becomes INACTIVE. Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.Format: UTC yyyy-MM-ddTHHZFor example, the following represents UTC October 10, 2021 at 10:00 AM:2021-10-10T10Z, scheduleName: str # The schedule name assigned by the user for the created schedule., scheduleStartDate: str # The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive. Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.Format: UTC yyyy-MM-ddTHHZFor example, the following represents a schedule start date of UTC October 01, 2020 at 12:00 PM: 2020-01-01T12Z, scheduleTemplateId: str # The unique identifier of the template to be used for this schedule. Use the getScheduleTemplates method to retrieve the schedule template ID. This method requires a schedule template ID that is ACTIVE.Note: Schedules are currently only available for LMS_ORDER_REPORT., schemaVersion: str # The schema version of a schedule.}\n@returns(201) Created\n@errors {400: Bad Request, 403: Forbidden, 409: Conflict, 500: Internal Server Error}\n\n@endpoint GET /schedule/{schedule_id}\n@desc 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.\n@required {schedule_id: str # This path parameter is the unique identifier of the schedule for which to retrieve details. Use the getSchedules method to retrieve schedule IDs.}\n@returns(200) {scheduleId: str, creationDate: str, feedType: str, lastModifiedDate: str, preferredTriggerDayOfMonth: int(int32), preferredTriggerDayOfWeek: str, preferredTriggerHour: str, scheduleEndDate: str, scheduleName: str, scheduleStartDate: str, scheduleTemplateId: str, schemaVersion: str, status: str, statusReason: str} # Success\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /schedule/{schedule_id}\n@desc 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.\n@required {schedule_id: str # This path parameter is the unique identifier of the schedule being updated.  Use the getSchedules method to retrieve schedule IDs., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {preferredTriggerDayOfMonth: int(int32) # The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the actual number of days in the month. This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value. Minimum: 1Maximum: 31, preferredTriggerDayOfWeek: str # The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules. This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value. For implementation help, refer to eBay API documentation, preferredTriggerHour: str # The preferred two-digit hour of the day to trigger the schedule. This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value. Format: UTC hhZFor example, the following represents 11:00 am UTC: 11ZMinimum: 00ZMaximum: 23Z, scheduleEndDate: str # The timestamp on which the schedule (report generation) ends. After this date, the schedule status becomes INACTIVE. Use this field, if available, to end the schedule in the future. This value must be later than scheduleStartDate (if supplied). This field is available as specified by the template (scheduleTemplateId). The template can specify this field as optional or required, and optionally provides a default value.Format: UTC yyyy-MM-ddTHHZFor example, the following represents UTC October 10, 2021 at 10:00 AM: 2021-10-10T10Z, scheduleName: str # The schedule name assigned by the user for the created schedule., scheduleStartDate: str # The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive. Use this field, if available, to start the schedule in the future but before the scheduleEndDate (if supplied). This field is available as specified by the template (scheduleTemplateId).  The template can specify this field as optional or required, and optionally provides a default value.Format: UTC yyyy-MM-ddTHHZFor example, the following represents a schedule start date of UTC October 01, 2020 at 12:00 PM: 2020-01-01T12Z, schemaVersion: str # The schema version of a schedule.}\n@returns(204) No Content\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint DELETE /schedule/{schedule_id}\n@desc This method deletes an existing schedule. Specify the schedule to delete using the schedule_id path parameter.\n@required {schedule_id: str # This path parameter is the unique identifier of the schedule being deleted.Use the getSchedules method to retrieve schedule IDs.}\n@returns(204) No Content\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /schedule/{schedule_id}/download_result_file\n@desc 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 schedule_id path parameter to download its last generated file.\n@required {schedule_id: str # This path parameter is the unique identifier of the schedule for which to retrieve the latest Order Report.  Use the getSchedules method to retrieve schedule IDs.}\n@returns(200) Success\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group schedule_template\n@endpoint GET /schedule_template/{schedule_template_id}\n@desc This method retrieves the details of the specified template. Specify the template to retrieve using the schedule_template_id path parameter. Use the getScheduleTemplates method to find a schedule template if you do not know the schedule_template_id.\n@required {schedule_template_id: str # This path parameter is the unique identifier of the schedule template being retrieved.Use the getScheduleTemplates method to retrieve schedule template IDs.Note: Template schedules are currently only available for LMS_ORDER_REPORT.}\n@returns(200) {feedType: str, frequency: str, name: str, scheduleTemplateId: str, status: str, supportedConfigurations: [map]} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /schedule_template\n@desc This method retrieves an array containing the details and status of all schedule templates based on the specified feed_type. Use this method to find a schedule template if you do not know the schedule_template_id.\n@required {feed_type: str # The feed type of the schedule templates to retrieve. Note: Schedules are currently only available for LMS_ORDER_REPORT.}\n@optional {limit: str # The maximum number of schedule templates 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 0.For example, if offset is set to 10 and limit is set to 10, the call retrieves schedule templates 11 thru 20 from the result set.If this parameter is omitted, the default value is used. Default:  10 Maximum: 500, offset: str # The number of schedule templates to skip in the result set before returning the first template 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 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, 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}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), prev: str, scheduleTemplates: [map], total: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group task\n@endpoint GET /task\n@desc This method returns the details and status for an array of 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 tasks are returned by specifying filters, such as the creation date range or period of time using look_back_days. Also, by specifying the feed_type, both on-demand and scheduled reports are returned.If specifying a schedule_id, the schedule template (that the schedule ID is based on) determines which tasks are returned (see schedule_id for additional information). Each scheduledId applies to one feed_type.\n@optional {date_range: str # 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.  Note: Maximum date range window size is 90 days. Valid Format (UTC):yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ For example: Tasks created on September 8, 2019 2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z, feed_type: str # The feed type associated with the tasks to be returned. Only use a feedType that is available for your API: Order Feeds: LMS_ORDER_ACK, LMS_ORDER_REPORTInventory Upload Feed Types: See Available FeedTypesDo 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., limit: str # 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 0.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, look_back_days: str # 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), offset: str # 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 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, 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, schedule_id: str # The unique identifier associated with the tasks being returned. A schedule periodically generates a report for the feed type specified by the schedule template.Note: Schedules are currently only available for LMS_ORDER_REPORT.Do not use with the feed_type parameter.}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), prev: str, tasks: [map], total: int(int32)} # Success\n@errors {400: Bad Request, 403: Forbidden, 500: Internal Server Error}\n\n@endpoint POST /task\n@desc This method creates an upload task or a download task without filter criteria. When using this method, specify the  feedType and the feed file  schemaVersion. The feed type specified sets the task as a download or an upload task.  For details about the upload and download flows, see Working with Order Feeds in the Selling Integration Guide. 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 scopes and their corresponding feed types:https://api.ebay.com/oauth/api_scope/sell.inventory: See LMS FeedTypeshttps://api.ebay.com/oauth/api_scope/sell.fulfillment: LMS_ORDER_ACK (specify for upload tasks). Also see LMS FeedTypeshttps://api.ebay.com/oauth/api_scope/sell.marketing: None*https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly: None** Reserved for future release\n@required {X-EBAY-C-MARKETPLACE-ID: str # The ID of the eBay marketplace where the item is hosted. For example:X-EBAY-C-MARKETPLACE-ID:EBAY_USThis identifies the eBay marketplace that applies to this task. See MarketplaceIdEnum for supported values.Note: When listing the items in the feed file on the French Canada and French Belgium marketplaces, also set the Accept-Language header as needed., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {Accept-Language: str # 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:French Canada: Set the X-EBAY-C-MARKETPLACE-ID header value to EBAY_CA and include the Accept-Language header with a value of fr-CA.French Belgium: Set the X-EBAY-C-MARKETPLACE-ID header value to EBAY_BE and include the Accept-Language header with a value of fr-BE., feedType: str # The feed type associated with the task. Available feed types:Inventory upload feed typesFulfillment upload feed typesSeller Hub feed types, schemaVersion: str # The schemaVersion/version number of the file format:Version Details / Schema VersionSeller Hub feed schema version}\n@returns(202) Accepted\n@errors {400: Bad Request, 403: Forbidden, 409: Conflict, 500: Internal Server Error}\n\n@endpoint GET /task/{task_id}/download_input_file\n@desc This method downloads the file previously uploaded using uploadFile. Specify the task_id from the uploadFile call. Note: With respect to LMS, this method applies to all feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT. See LMS API Feeds in the Selling Integration Guide.\n@required {task_id: str # This path parameter is the unique identifier of the task associated with the input file to be downloaded.Use the getTasks method to retrieve task IDs.}\n@returns(200) Success\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /task/{task_id}/download_result_file\n@desc 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). For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide. Note: 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.\n@required {task_id: str # This path parameter is the unique identifier of the task associated with the file to be downloaded. Use the getTasks method to retrieve task IDs.}\n@returns(200) Success\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /task/{task_id}\n@desc This method retrieves the details and status of the specified task. The input is task_id. For details of how this method is used, see Working with Order Feeds in the Selling Integration Guide.\n@required {task_id: str # This path parameter is the unique identifier of the task being retrieved.Use the getTasks method to retrieve task IDs.}\n@returns(200) {completionDate: str, creationDate: str, detailHref: str, feedType: str, schemaVersion: str, status: str, taskId: str, uploadSummary: map{failureCount: int(int32), successCount: int(int32)}} # Success\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /task/{task_id}/upload_file\n@desc 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. 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  getTask with the task ID or  getTasks to determine the status of a report. The status flow is QUEUED > IN_PROCESS > COMPLETED or COMPLETED_WITH_ERROR. When the status is COMPLETED or COMPLETED_WITH_ERROR, 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. For details of how this method is used in the upload flow, see Working with Order Feeds in the Selling Integration Guide. This call does not have a JSON Request payload but uploads the file as form-data. For example:  fileName: \"AddFixedPriceItem_Macbook.xml\"  name: \"file\"  type: \"form-data\"  file: @\"/C:/Users/.../AddFixedPriceItem_Macbook.7z\"See Samples for information.Note: This method applies to all Seller Hub feed types, and to all LMS feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT. Note: You must use a Content-Type header with its value set to \"multipart/form-data\". See Samples for information.Note: For LMS feed types, upload a regular XML file or an XML file in zipped format (both formats are allowed).\n@required {task_id: str # This path parameter is the unique identifier of the task associated with the file that will be uploaded.Use the getTasks method to retrieve task IDs., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to multipart/form-data.  For more information, refer to HTTP request headers.}\n@returns(200) Success\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group customer_service_metric_task\n@endpoint GET /customer_service_metric_task\n@desc 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 look_back_days or date_range, but not both.\n@optional {date_range: str # 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 look_back_days parameter.Format: UTCFor example, tasks within a range: yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ Tasks created on March 8, 20202020-03-08T00:00.00.000Z..2020-03-09T00:00:00.000ZMaximum: 90 days, feed_type: str # The feed type associated with the tasks being retrieved. The only presently supported value is CUSTOMER_SERVICE_METRICS_REPORT., limit: str # 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 0.Default: 10 Maximum: 500, look_back_days: str # 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 value: 7Range: 1-90 (inclusive), offset: str # 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 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. Default: 0}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), prev: str, tasks: [map], total: int(int32)} # Success\n@errors {400: Bad Request, 403: Forbidden, 500: Internal Server Error}\n\n@endpoint POST /customer_service_metric_task\n@desc 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 getCustomerServiceMetric 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 Analytics API). 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.\n@required {Accept-Language: str # Use this header to specify the natural language in which the authenticated user desires the response. For example, en-US for English or de-DE for German., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {feedType: str # The feedType 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:CUSTOMER_SERVICE_METRICS_REPORT, filterCriteria: map{customerServiceMetricType: str, evaluationMarketplaceId: str, listingCategories: [str], shippingRegions: [str]} # A complex data type that filters data for report creation. See CustomerServiceMetricsFilterCriteria for fields and descriptions., schemaVersion: str # The version number of the customer service metric.Note: This field must have a value of 1.0.}\n@returns(202) Accepted\n@errors {400: Bad Request, 403: Forbidden, 500: Internal Server Error}\n\n@endpoint GET /customer_service_metric_task/{task_id}\n@desc Use this method to retrieve customer service metric task details for the specified task. The input is task_id.\n@required {task_id: str # This path parameter is the unique identifier of the customer service metric task being retrieved.Use the getCustomerServiceMetricTasks method to retrieve task IDs.}\n@returns(200) {completionDate: str, creationDate: str, detailHref: str, feedType: str, filterCriteria: map{customerServiceMetricType: str, evaluationMarketplaceId: str, listingCategories: [str], shippingRegions: [str]}, schemaVersion: str, status: str, taskId: str} # Success\n@errors {400: Bad Request, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}}