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.
" contact: name: "eBay Inc," license: name: "eBay API License Agreement" url: "https://developer.ebay.com/join/api-license-agreement" version: "v1.3.1" servers: - url: "https://api.ebay.com{basePath}" description: "Production" variables: basePath: default: "/sell/feed/v1" paths: /order_task: get: tags: - "order_task" description: "This method returns the details and status for an array of order\ \ tasks based on a specified 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.yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ \
\ 2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000ZLMS_ORDER_REPORT 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
" required: false schema: type: "string" - name: "look_back_days" in: "query" description: "The number of previous days in which to search for tasks. Do\ \ not use with the date_range parameter. If both date_range\ \ and look_back_days are omitted, this parameter's default\ \ value is used.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"
required: false
schema:
type: "string"
- name: "schedule_id"
in: "query"
description: "The schedule ID associated with the order tasks being retrieved.\
\ A schedule periodically generates a report, and these schedules can be\
\ created with the 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."
required: false
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/OrderTaskCollection"
"400":
description: "Bad Request"
x-response-codes:
errors:
160006:
domain: "API_FEED"
category: "REQUEST"
description: "The 'feed_type' {feedTypeValue} is invalid."
160007:
domain: "API_FEED"
category: "REQUEST"
description: "The 'schedule_id' {scheduleID} is invalid."
160004:
domain: "API_FEED"
category: "REQUEST"
description: "You must submit either a 'feed_type' or 'schedule_id'."
160005:
domain: "API_FEED"
category: "REQUEST"
description: "Both 'feed_type' and 'schedule_id' were provided. Please\
\ remove one of them."
160010:
domain: "API_FEED"
category: "REQUEST"
description: "The 'date_range' must be less than or equal to 90 days."
160011:
domain: "API_FEED"
category: "REQUEST"
description: "The 'look_back_days' value must be greater than zero\
\ and less than or equal to 90."
160008:
domain: "API_FEED"
category: "REQUEST"
description: "Both 'look_back_days' and 'date_range' were provided.\
\ Please remove one of them."
160009:
domain: "API_FEED"
category: "REQUEST"
description: "The format of the 'date_range' is invalid. The format\
\ for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ."
160012:
domain: "API_FEED"
category: "REQUEST"
description: "The 'limit' value must be greater than zero and less\
\ than or equal to 500."
160013:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value cannot be less than zero."
160029:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value must be a multiple of the 'limit'\
\ value."
"500":
description: "Internal Server Error"
x-response-codes:
errors:
160001:
domain: "API_FEED"
category: "APPLICATION"
description: "There was a problem with an eBay internal system or\
\ process. Contact eBay Developer Technical Support for assistance."
"403":
description: "Forbidden"
x-response-codes:
errors:
160002:
domain: "API_FEED"
category: "REQUEST"
description: "The authentication scope {scope} is incorrect for 'feed_type'\
\ {feedType}. Refer to documentation for details about the scopes."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.fulfillment"
post:
tags:
- "order_task"
description: "This method creates an order download task with filter criteria\
\ for the order report. When using this method, specify the 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:
For details about how this method is used,\ \ see General feed types in the Selling Integration Guide.
For details about how this\ \ method is used, see Working with Order Feeds in the Selling Integration Guide.
" operationId: "getOrderTask" parameters: - name: "task_id" in: "path" description: "This path parameter is the unique identifier of the order task\ \ being retrieved.LMS_ACTIVE_INVENTORY_REPORTdate_range parameter. If both date_range\
\ and look_back_days are omitted, this parameter's default\
\ value is used.
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z 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"
required: false
schema:
type: "string"
- name: "offset"
in: "query"
description: "The number of tasks to skip in the result set before returning\
\ the first task in the paginated response.
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"
required: false
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/InventoryTaskCollection"
"400":
description: "Bad Request"
x-response-codes:
errors:
160006:
domain: "API_FEED"
category: "REQUEST"
description: "The 'feed_type' {feedTypeValue} is invalid."
160007:
domain: "API_FEED"
category: "REQUEST"
description: "The 'schedule_id' {scheduleID} is invalid."
160004:
domain: "API_FEED"
category: "REQUEST"
description: "You must submit either a 'feed_type' or 'schedule_id'."
160005:
domain: "API_FEED"
category: "REQUEST"
description: "Both 'feed_type' and 'schedule_id' were provided. Please\
\ remove one of them."
160010:
domain: "API_FEED"
category: "REQUEST"
description: "The 'date_range' must be less than or equal to 90 days."
160011:
domain: "API_FEED"
category: "REQUEST"
description: "The 'look_back_days' value must be greater than zero\
\ and less than or equal to 90."
160008:
domain: "API_FEED"
category: "REQUEST"
description: "Both 'look_back_days' and 'date_range' were provided.\
\ Please remove one of them."
160009:
domain: "API_FEED"
category: "REQUEST"
description: "The format of the 'date_range' is invalid. The format\
\ for a date range is yyyy-MM-ddThh:mm:ss.sssZ..yyyy-MM-ddThh:mm:ss.sssZ."
160012:
domain: "API_FEED"
category: "REQUEST"
description: "The 'limit' value must be greater than zero and less\
\ than or equal to 500."
160013:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value cannot be less than zero."
160029:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value must be a multiple of the 'limit'\
\ value."
"500":
description: "Internal Server Error"
x-response-codes:
errors:
160001:
domain: "API_FEED"
category: "APPLICATION"
description: "There was a problem with an eBay internal system or\
\ process. Contact eBay Developer Technical Support for assistance."
"403":
description: "Forbidden"
x-response-codes:
errors:
160002:
domain: "API_FEED"
category: "REQUEST"
description: "The authentication scope {scope} is incorrect for 'feed_type'\
\ {feedType}. Refer to documentation for details about the scopes."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.inventory"
post:
tags:
- "inventory_task"
description: "This method creates an inventory-related download task for a specified\
\ feed type with optional filter criteria. When using this method, specify\
\ the 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" parameters: - name: "Content-Type" in: "header" description: "This header indicates the format of the request body provided\ \ by the client. Its value should be set to application/json.LMS_ORDER_REPORT."
required: true
schema:
type: "string"
- name: "limit"
in: "query"
description: "The maximum number of schedules that can be returned on each\
\ page of the paginated response. Use this parameter in conjunction with\
\ the 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"
required: false
schema:
type: "string"
- name: "offset"
in: "query"
description: "The number of schedules to skip in the result set before returning\
\ the first schedule in the paginated response.
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"
required: false
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/UserScheduleCollection"
"400":
description: "Bad Request"
x-response-codes:
errors:
160017:
domain: "API_FEED"
category: "REQUEST"
description: "The 'feedType' is missing or invalid."
160012:
domain: "API_FEED"
category: "REQUEST"
description: "The 'limit' value must be greater than zero and less\
\ than or equal to 500."
160013:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value cannot be less than zero."
160029:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value must be a multiple of the 'limit'\
\ value."
"500":
description: "Internal Server Error"
x-response-codes:
errors:
160001:
domain: "API_FEED"
category: "APPLICATION"
description: "There was a problem with an eBay internal system or\
\ process. Contact eBay Developer Technical Support for assistance."
"403":
description: "Forbidden"
x-response-codes:
errors:
160002:
domain: "API_FEED"
category: "REQUEST"
description: "The authentication scope {scope} is incorrect for 'feed_type'\
\ {feedType}. Refer to documentation for details about the scopes."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.inventory"
- "https://api.ebay.com/oauth/api_scope/sell.fulfillment"
- "https://api.ebay.com/oauth/api_scope/sell.marketing"
- "https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly"
- "https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
post:
tags:
- "schedule"
description: "This method creates a schedule, which is a subscription to the\
\ specified schedule template. A schedule periodically generates a report\
\ for the 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.\ \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" parameters: - name: "Content-Type" in: "header" description: "This header indicates the format of the request body provided\ \ by the client. Its value should be set to application/json.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: - name: "schedule_id" in: "path" description: "This path parameter is the unique identifier of the schedule\ \ being updated.LMS_ORDER_REPORT."
required: true
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/ScheduleTemplateResponse"
"400":
description: "Bad Request"
"500":
description: "Internal Server Error"
x-response-codes:
errors:
160001:
domain: "API_FEED"
category: "APPLICATION"
description: "There was a problem with an eBay internal system or\
\ process. Contact eBay Developer Technical Support for assistance."
"404":
description: "Not Found"
x-response-codes:
errors:
160039:
domain: "API_FEED"
category: "REQUEST"
description: "The schedule template id {schedule_template_id} does\
\ not exist. Please provide a valid schedule template id as contained\
\ in the documentation or by calling the getScheduleTemplates method."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.inventory"
- "https://api.ebay.com/oauth/api_scope/sell.fulfillment"
- "https://api.ebay.com/oauth/api_scope/sell.marketing"
- "https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly"
- "https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
/schedule_template:
get:
tags:
- "schedule"
description: "This method retrieves an array containing the details and status\
\ of all schedule templates based on the specified feed_type.\
\ Use this method to find a schedule template if you do not know the schedule_template_id."
operationId: "getScheduleTemplates"
parameters:
- name: "feed_type"
in: "query"
description: "The feed type of the schedule templates to retrieve. LMS_ORDER_REPORT."
required: true
schema:
type: "string"
- name: "limit"
in: "query"
description: "The maximum number of schedule templates that can be returned\
\ on each page of the paginated response. Use this parameter in conjunction\
\ with the 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"
required: false
schema:
type: "string"
- name: "offset"
in: "query"
description: "The number of schedule templates to skip in the result set before\
\ returning the first template in the paginated response.
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"
required: false
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/ScheduleTemplateCollection"
"400":
description: "Bad Request"
x-response-codes:
errors:
160017:
domain: "API_FEED"
category: "REQUEST"
description: "The 'feedType' is missing or invalid."
160012:
domain: "API_FEED"
category: "REQUEST"
description: "The 'limit' value must be greater than zero and less\
\ than or equal to 500."
160013:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value cannot be less than zero."
160029:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value must be a multiple of the 'limit'\
\ value."
"500":
description: "Internal Server Error"
x-response-codes:
errors:
160001:
domain: "API_FEED"
category: "APPLICATION"
description: "There was a problem with an eBay internal system or\
\ process. Contact eBay Developer Technical Support for assistance."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.inventory"
- "https://api.ebay.com/oauth/api_scope/sell.fulfillment"
- "https://api.ebay.com/oauth/api_scope/sell.marketing"
- "https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly"
- "https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
/task:
get:
tags:
- "task"
description: "This method returns the details and status for an array of tasks\
\ based on a specified 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. "
operationId: "getTasks"
parameters:
- name: "date_range"
in: "query"
description: "Specifies the range of task creation dates used to filter the\
\ results. The results are filtered to include only tasks with a creation\
\ date that is equal to this date or is within specified range. Only tasks\
\ that are less than 90 days can be retrieved.
Note: Maximum date range window size is 90 days.
\ \yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ\
\ 2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z"
required: false
schema:
type: "string"
- name: "feed_type"
in: "query"
description: "The feed type associated with the tasks to be returned. Only\
\ use a feedType that is available for your API: LMS_ORDER_ACK, LMS_ORDER_REPORT 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"
required: false
schema:
type: "string"
- name: "look_back_days"
in: "query"
description: "The number of previous days in which to search for tasks. Do\
\ not use with the 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)"
required: false
schema:
type: "string"
- name: "offset"
in: "query"
description: "The number of tasks to skip in the result set before returning\
\ the first task in the paginated response.
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"
required: false
schema:
type: "string"
- name: "schedule_id"
in: "query"
description: "The unique identifier associated with the tasks being returned.\
\ A schedule periodically generates a report for the feed type specified\
\ by the schedule template.
Note:\
\ Schedules are currently only available for LMS_ORDER_REPORT.
Do\
\ not use with the feed_type parameter."
required: false
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/TaskCollection"
"400":
description: "Bad Request"
x-response-codes:
errors:
160016:
domain: "API_FEED"
category: "REQUEST"
description: "The 'date_range' value is not valid. Ensure that the\
\ beginning of the range is before the end of the range."
160006:
domain: "API_FEED"
category: "REQUEST"
description: "The 'feed_type' {feedTypeValue} is invalid."
160007:
domain: "API_FEED"
category: "REQUEST"
description: "The 'schedule_id' {scheduleID} is invalid."
160004:
domain: "API_FEED"
category: "REQUEST"
description: "You must submit either a 'feed_type' or 'schedule_id'."
160005:
domain: "API_FEED"
category: "REQUEST"
description: "Both 'feed_type' and 'schedule_id' were provided. Please\
\ remove one of them."
160010:
domain: "API_FEED"
category: "REQUEST"
description: "The 'date_range' must be less than or equal to 90 days."
160011:
domain: "API_FEED"
category: "REQUEST"
description: "The 'look_back_days' value must be greater than zero\
\ and less than or equal to 90."
160008:
domain: "API_FEED"
category: "REQUEST"
description: "Both 'look_back_days' and 'date_range' were provided.\
\ Please remove one of them."
160009:
domain: "API_FEED"
category: "REQUEST"
description: "The format of the 'date_range' is invalid. The format\
\ for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ."
160012:
domain: "API_FEED"
category: "REQUEST"
description: "The 'limit' value must be greater than zero and less\
\ than or equal to 500."
160013:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value cannot be less than zero."
160029:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value must be a multiple of the 'limit'\
\ value."
"500":
description: "Internal Server Error"
x-response-codes:
errors:
160001:
domain: "API_FEED"
category: "APPLICATION"
description: "There was a problem with an eBay internal system or\
\ process. Contact eBay Developer Technical Support for assistance."
"403":
description: "Forbidden"
x-response-codes:
errors:
160002:
domain: "API_FEED"
category: "REQUEST"
description: "The authentication scope {scope} is incorrect for 'feed_type'\
\ {feedType}. Refer to documentation for details about the scopes."
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.inventory"
- "https://api.ebay.com/oauth/api_scope/sell.fulfillment"
- "https://api.ebay.com/oauth/api_scope/sell.marketing"
- "https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly"
- "https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
post:
tags:
- "task"
description: "This method creates an upload task or a download task without\
\ filter criteria. When using this method, specify the 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.
The following list contains this method's authorization\ \ scopes and their corresponding feed types:
* Reserved for future release
" operationId: "createTask" parameters: - name: "X-EBAY-C-MARKETPLACE-ID" in: "header" description: "The ID of the eBay marketplace where the item is hosted.X-EBAY-C-MARKETPLACE-ID:EBAY_USEBAY_CA\
\ and include the Accept-Language header with a value of fr-CA.EBAY_BE\
\ and include the Accept-Language header with a value of fr-BE.LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT.\
\ See LMS API Feeds\
\ in the Selling Integration Guide.
For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide.
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. fileName: "AddFixedPriceItem_Macbook.xml"\
\
name: "file"
type: "form-data"
\
\ file: @"/C:/Users/.../AddFixedPriceItem_Macbook.7z"See 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).
" operationId: "uploadFile" parameters: - name: "task_id" in: "path" description: "This path parameter is the unique identifier of the task associated\ \ with the file that will be uploaded. Note: You can pass in either\
\ the look_back_days or date_range, but not both.
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 March 8, 2020
2020-03-08T00:00.00.000Z..2020-03-09T00:00:00.000Z
Maximum:\ \ 90 days
" required: false schema: type: "string" - name: "feed_type" in: "query" description: "The feed type associated with the tasks being retrieved. The\ \ only presently supported value isCUSTOMER_SERVICE_METRICS_REPORT."
required: false
schema:
type: "string"
- name: "limit"
in: "query"
description: "The number of customer service metric tasks to return per page\
\ of the result set. Use this parameter in conjunction with the offset parameter\
\ to control the pagination of the output. 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
" required: false schema: type: "string" - name: "look_back_days" in: "query" description: "The number of previous days in which to search for tasks. Do\ \ not use with thedate_range parameter. If both date_range\
\ and look_back_days are omitted, this parameter's default\
\ value is used. Default value: 7
Range: 1-90 (inclusive)
" required: false schema: type: "string" - name: "offset" in: "query" description: "The number of customer service metric tasks to skip in the result\ \ set before returning the first task in the paginated response.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"
required: false
schema:
type: "string"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerServiceMetricTaskCollection"
"400":
description: "Bad Request"
x-response-codes:
errors:
160002:
domain: "API_FEED"
category: "REQUEST"
description: "The authentication scope {scope} is incorrect for 'feed_type'\
\ {feedType}. Refer to documentation for details about the scopes."
160006:
domain: "API_FEED"
category: "REQUEST"
description: "The 'feed_type' {feedTypeValue} is invalid."
160005:
domain: "API_FEED"
category: "REQUEST"
description: "Both 'feed_type' and 'schedule_id' were provided. Please\
\ remove one of them."
160010:
domain: "API_FEED"
category: "REQUEST"
description: "The 'date_range' must be less than or equal to 90 days."
160011:
domain: "API_FEED"
category: "REQUEST"
description: "The 'look_back_days' value must be greater than zero\
\ and less than or equal to 90."
160008:
domain: "API_FEED"
category: "REQUEST"
description: "Both 'look_back_days' and 'date_range' were provided.\
\ Please remove one of them."
160009:
domain: "API_FEED"
category: "REQUEST"
description: "The format of the 'date_range' is invalid. The format\
\ for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ."
160012:
domain: "API_FEED"
category: "REQUEST"
description: "The 'limit' value must be greater than zero and less\
\ than or equal to 500."
160013:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value cannot be less than zero."
160029:
domain: "API_FEED"
category: "REQUEST"
description: "The 'offset' value must be a multiple of the 'limit'\
\ value."
"500":
description: "Internal Server Error"
x-response-codes:
errors:
160001:
domain: "API_FEED"
category: "APPLICATION"
description: "There was a problem with an eBay internal system or\
\ process. Contact eBay Developer Technical Support for assistance."
"403":
description: "Forbidden"
security:
- api_auth:
- "https://api.ebay.com/oauth/api_scope/sell.analytics.readonly"
post:
tags:
- "customer_service_metric_task"
description: "
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.
" operationId: "createCustomerServiceMetricTask" parameters: - name: "Accept-Language" in: "header" description: "Use this header to specify the natural language in which the\ \ authenticated user desires the response. For example,en-US\
\ for English or de-DE for German."
required: true
schema:
type: "string"
- name: "Content-Type"
in: "header"
description: "This header indicates the format of the request body provided\
\ by the client. Its value should be set to application/json. Use this method to retrieve customer service metric task details\ \ for the specified task. The input is task_id.
" operationId: "getCustomerServiceMetricTask" parameters: - name: "task_id" in: "path" description: "This path parameter is the unique identifier of the customer\ \ service metric task being retrieved.LMS_ACTIVE_INVENTORY_REPORT1.0."
description: "This type defines inventory-related download task request fields."
CreateOrderTaskRequest:
type: "object"
properties:
feedType:
type: "string"
description: "The feed type associated with the task. The only presently\
\ supported value is LMS_ORDER_REPORT.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. CUSTOMER_SERVICE_METRICS_REPORT
1.0."
description: "The type that defines the fields for the Customer Service Metric\
\ reports generated with the Feed API."
CreateTaskRequest:
type: "object"
properties:
feedType:
type: "string"
description: "The feed type associated with the task. Available feed types:LMS_ORDER_REPORT."
preferredTriggerDayOfMonth:
type: "integer"
description: "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. hhZ 11Z"
scheduleEndDate:
type: "string"
description: "The timestamp on which the report generation (subscription)\
\ ends. After this date, the schedule status becomes INACTIVE.\
\ yyyy-MM-ddTHHZ2021-10-10T10Z"
scheduleName:
type: "string"
description: "The schedule name assigned by the user for the created schedule."
scheduleStartDate:
type: "string"
description: "The timestamp to start generating the report. After this timestamp,\
\ the schedule status becomes active until either the scheduleEndDate\
\ occurs or the scheduleTemplateId becomes inactive.\
\ yyyy-MM-ddTHHZ 2020-01-01T12Z"
scheduleTemplateId:
type: "string"
description: "The unique identifier of the template to be used for this\
\ schedule. ACTIVE.LMS_ORDER_REPORT."
schemaVersion:
type: "string"
description: "The schema version of a schedule."
description: "The type that defines the fields for the createSchedule\
\ method."
CustomerServiceMetricTaskCollection:
type: "object"
properties:
href:
type: "string"
description: "The URI of the current page of results."
limit:
type: "integer"
description: "The value of the limit parameter submitted\
\ in the request, which is the maximum number of tasks to return per page,\
\ from the result set. A result set is the complete set of tasks returned\
\ by the method. Note:\ \ Even though this parameter is not required to be submitted in the request,\ \ the parameter defaults to 10 if omitted.
Note: If this is the last or only page of\
\ the result set, the page may contain fewer tasks than the limit value.\
\ To determine the number of pages in a result set, divide the total value\
\ (total number of tasks matching input criteria) by this limit value,\
\ and then round up to the next integer. For example, if the total\
\ value was 120 (120 total tasks) and the limit\
\ value was 50 (show 50 tasks per page), the total number\
\ of pages in the result set is three, so the seller would have to make\
\ three separate getCustomerServiceMetricTasks calls\
\ to view all tasks matching the input criteria.
Note: The items\
\ in a paginated result set use a zero-based list where the first item\
\ in the list has an offset of 0.
Note: Pass this attribute to narrow down your filter\
\ results for the ITEM_NOT_AS_DESCRIBED customerServiceMetricType.
Supported categories include:
primary(L1) category Id
Note: Pass this attribute\
\ to narrow down your filter results for the ITEM_NOT_RECEIVED\
\ customerServiceMetricType.
Supported categories include:
primary(L1)\
\ category Id
yyyy-MM-ddThh:mm:ss.SSSZ\
\ yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ \
\ 2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z\
\ "
to:
type: "string"
description: "The end date for the date range, which is inclusive. If the\
\ parent type is included, both the from and/or the to\
\ fields become conditionally required. yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ\
\ 2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z\
\ "
description: "The type that defines the fields for a date range."
Error:
type: "object"
properties:
category:
type: "string"
description: "Identifies the type of erro."
domain:
type: "string"
description: "Name for the primary system where the error occurred. This\
\ is relevant for application errors."
errorId:
type: "integer"
description: "A unique number to identify the error."
format: "int32"
inputRefIds:
type: "array"
description: "An array of request elements most closely associated to the\
\ error."
items:
type: "string"
longMessage:
type: "string"
description: "A more detailed explanation of the error."
message:
type: "string"
description: "Information on how to correct the problem, in the end user's\
\ terms and language where applicable."
outputRefIds:
type: "array"
description: "An array of request elements most closely associated to the\
\ error."
items:
type: "string"
parameters:
type: "array"
description: "An array of name/value pairs that describe details the error\
\ condition. These are useful when multiple errors are returned."
items:
$ref: "#/components/schemas/ErrorParameter"
subdomain:
type: "string"
description: "Further helps indicate which subsystem the error is coming\
\ from. System subcategories include: Initialization, Serialization, Security,\
\ Monitoring, Rate Limiting, etc."
description: "This type defines the fields that can be returned in an error."
ErrorParameter:
type: "object"
properties:
name:
type: "string"
description: "The object of the error."
value:
type: "string"
description: "The value of the object."
InventoryFilterCriteria:
type: "object"
properties:
listingFormat:
type: "string"
description: "The listing format for the ActiveInventoryReport being created.\
\ Supported types are:AUCTIONFIXED_PRICECOMPLETED, COMPLETED_WITH_ERROR, or PARTIALLY_PROCESSED\
\ state. This field is only returned if the status is one of the three\
\ completed values."
schemaVersion:
type: "string"
description: "The schema version number associated with the task."
detailHref:
type: "string"
description: "The path to the call URI used to retrieve the task. This field\
\ points to the getInventoryTask URI."
uploadSummary:
description: "This container provides summary information on an upload feed\
\ (not applicable for download feed types)."
$ref: "#/components/schemas/UploadSummary"
filterCriteria:
description: "This container is used to set the filter criteria for the\
\ ActiveInventoryReport. A seller can retrieve listings for a specified\
\ format."
$ref: "#/components/schemas/InventoryFilterCriteria"
InventoryTaskCollection:
type: "object"
properties:
href:
type: "string"
description: "The path to the call URI that produced the current page of\
\ results."
limit:
type: "integer"
description: "The value of the limit parameter submitted\
\ in the request, which is the maximum number of inventory tasks to return\
\ per page, from the result set. A result set is the complete set of tasks\
\ returned by the method.10 if omitted. Additionally,\
\ if this is the last or only page of the result set, the page may contain\
\ fewer tasks than the limit value submitted in the request.120 (120 total tasks)\
\ and the limit value was 50 (show 50 tasks\
\ per page), the total number of pages in the result set is three, so\
\ the seller would have to make three separate getInventoryTasks\
\ calls to view all tasks matching the input criteria."
format: "int32"
next:
type: "string"
description: "The path to the call URI for the next page of results. This\
\ value is returned if there is an additional page of results to return\
\ from the result set."
offset:
type: "integer"
description: "The number of results skipped in the result set before listing\
\ the first returned result. This value can be specified in the request\
\ with the offset query parameter.0."
format: "int32"
prev:
type: "string"
description: "The path to the call URI for the previous page of results.\
\ This is returned if there is a previous page of results from the result\
\ set."
tasks:
type: "array"
description: "An array of the inventory tasks on this page. The tasks are\
\ sorted by creation date.\ \ Note: This container is for\ \ future use. At this time, the createOrderTask method\ \ only supports order creation date filters and not modified order date\ \ filters.
" $ref: "#/components/schemas/DateRange" orderStatus: type: "string" description: "The order status of the orders returned. If the filter is\ \ omitted from createOrderTask call, orders that are in bothACTIVE\
\ and COMPLETED states are returned. For implementation\
\ help, refer to eBay\
\ API documentation"
description: "The type that defines the fields for the order filters."
OrderTask:
type: "object"
properties:
completionDate:
type: "string"
description: "The timestamp when the task went into the COMPLETED\
\ or COMPLETED_WITH_ERROR state. This state means that eBay\
\ has compiled the report for the seller based on the seller’s filter\
\ criteria, and the seller can run a getResultFile call\
\ to download the report."
creationDate:
type: "string"
description: "The date the task was created."
detailHref:
type: "string"
description: "The path to the call URI used to retrieve the task."
feedType:
type: "string"
description: "The feed type associated with the task."
filterCriteria:
description: "A container that returns the filter criteria used."
$ref: "#/components/schemas/OrderFilterCriteria"
schemaVersion:
type: "string"
description: "The schema version number associated with the create task."
status:
type: "string"
description: "The enumeration value that indicates the state of the task\
\ that was submitted in the request. See FeedStatusEnum\
\ for information. The values COMPLETED and COMPLETED_WITH_ERROR\
\ indicate the Order Report file is ready to download.
Note:\
\ Though this parameter is not required to be submitted in the request,\
\ the parameter defaults to 10 if omitted.
\
\ Note: If this is the last\
\ or only page of the result set, the page may contain fewer tasks than\
\ the limit value. To determine the number of pages in\
\ a result set, divide the total value (total number of tasks matching\
\ input criteria) by this limit value, and then round up to the next integer.\
\ For example, if the total value was 120\
\ (120 total tasks) and the limit value was 50\
\ (show 50 tasks per page), the total number of pages in the result set\
\ is three, so the seller would have to make three separate getOrderTasks\
\ calls to view all tasks matching the input criteria.
Note:\
\ The items in a paginated result set use a zero-based list where\
\ the first item in the list has an offset of 0.
Note: Though this parameter is not required to be submitted\ \ in the request, the parameter defaults to 10 if omitted.
\
\ Note: If this is the last\
\ or only page of the result set, the page may contain fewer tasks than\
\ the limit value. To determine the number of pages in\
\ a result set, divide the total value (total number of tasks matching\
\ input criteria) by this limit value, and then round up to the next integer.\
\ For example, if the total value was 120\
\ (120 total tasks) and the limit value was 50\
\ (show 50 tasks per page), the total number of pages in the result set\
\ is three, so the seller would have to make three separate getScheduleTemplates\
\ calls to view all tasks matching the input criteria.
Note:\
\ The items in a paginated result set use a zero-based list where\
\ the first item in the list has an offset of 0.
Note: When calling createSchedule\ \ and updateSchedule methods you must match the feed\ \ type specified by the schedule template (this feedType).
" frequency: type: "string" description: "This field specifies how often the schedule is generated.\ \ If set toHALF_HOUR or ONE_HOUR, you cannot\
\ set a preferredTriggerHour using createSchedule\
\ or updateSchedule. For implementation help, refer to\
\ eBay\
\ API documentation"
name:
type: "string"
description: "The template name provided by the template."
scheduleTemplateId:
type: "string"
description: "The ID of the template. Use this ID to create a schedule based\
\ on the properties of this schedule template."
status:
type: "string"
description: "The present status of the template. You cannot create or modify\
\ a schedule using a template with an INACTIVE status. For\
\ implementation help, refer to eBay\
\ API documentation"
supportedConfigurations:
type: "array"
description: "An array of the configuration supported by this template."
items:
$ref: "#/components/schemas/SupportedConfiguration"
description: "The type that defines the fields for a paginated result set of\
\ available schedule templates. The response consists of 0 or more sequenced\
\ pages where each page has 0 or more items."
ServiceMetricsTask:
type: "object"
properties:
completionDate:
type: "string"
description: "The timestamp when the customer service metrics task went\
\ into the COMPLETED or COMPLETED_WITH_ERROR\
\ state. This field is only returned if the status is one of the two completed\
\ values. This state means that eBay has compiled the report for the seller\
\ based on the seller’s filter criteria, and the seller can run a getResultFile\
\ call to download the report."
creationDate:
type: "string"
description: "The date the customer service metrics task was created."
detailHref:
type: "string"
description: "The relative getCustomerServiceMetricTask\
\ call URI path to retrieve the corresponding task."
feedType:
type: "string"
description: "The feed type associated with the task."
filterCriteria:
description: "This container shows the criteria set for the report."
$ref: "#/components/schemas/CustomerServiceMetricsFilterCriteria"
schemaVersion:
type: "string"
description: "The schema version number of the file format. If omitted,\
\ the default value is used. Default value: 1.0
" status: type: "string" description: "An enumeration value that indicates the state of the task.\ \ See FeedStatusEnum for values. For implementation help,\ \ refer to eBay\ \ API documentation" taskId: type: "string" description: "The unique eBay-assigned ID of the task." description: "This type defines customer service metric task response fields." StreamingOutput: type: "object" description: "File stream" SupportedConfiguration: type: "object" properties: defaultValue: type: "string" description: "The default value for the property. If a value is omitted\ \ from the schedule and a default value is supplied, the default value\ \ is used." property: type: "string" description: "Properties supported by the template. Properties can include\ \ the following:
yyyy-MM-ddTHHZyyyy-MM-ddTHHZhhZCOMPLETED\
\ or COMPLETED_WITH_ERROR state. This state means that eBay\
\ has compiled the report for the seller based on the seller’s filter\
\ criteria, and the seller can run a getResultFile call\
\ to download the report."
creationDate:
type: "string"
description: "The date the task was created."
detailHref:
type: "string"
description: "The path to the call URI used to retrieve the task. This field\
\ points to the GetOrderTask URI if the task is for LMS_ORDER_REPORT\
\ or will be null if this task is for LMS_ORDER_ACK."
feedType:
type: "string"
description: "The feed type associated with the task."
schemaVersion:
type: "string"
description: "The schema version number associated with the task."
status:
type: "string"
description: "The enumeration value that indicates the state of the task\
\ that was submitted in the request. See FeedStatusEnum\
\ for information. The values COMPLETED and COMPLETED_WITH_ERROR\
\ indicate the Order Report file is ready to download.
Note:\ \ Though this parameter is not required to be submitted in the request,\ \ the parameter defaults to 10 if omitted.
Note: If this is the last or only page of\
\ the result set, the page may contain fewer tasks than the limit\
\ value. To determine the number of pages in a result set, divide the\
\ total value (total number of tasks matching input criteria) by this\
\ limit value, and then round up to the next integer. For example, if\
\ the total value was 120 (120 total tasks)\
\ and the limit value was 50 (show 50 tasks\
\ per page), the total number of pages in the result set is three, so\
\ the seller would have to make three separate getTasks\
\ calls to view all tasks matching the input criteria.
Note:\
\ The items in a paginated result set use a zero-based list where\
\ the first item in the list has an offset of 0.
hhZ 11Z00Z23Z"
scheduleEndDate:
type: "string"
description: "The timestamp on which the schedule (report generation) ends.\
\ After this date, the schedule status becomes INACTIVE.\
\ yyyy-MM-ddTHHZ 2021-10-10T10Z"
scheduleName:
type: "string"
description: "The schedule name assigned by the user for the created schedule."
scheduleStartDate:
type: "string"
description: "The timestamp to start generating the report. After this timestamp,\
\ the schedule status becomes active until either the scheduleEndDate\
\ occurs or the scheduleTemplateId becomes inactive.\
\ yyyy-MM-ddTHHZ 2020-01-01T12Z"
schemaVersion:
type: "string"
description: "The schema version of a schedule."
description: "The type that defines the fields for a schedule update to a schedule\
\ generated with the Feed API."
UploadSummary:
type: "object"
properties:
failureCount:
type: "integer"
description: "The number of records, such as the number of listings created\
\ or the number of pictures uploaded to a listing, that failed to process\
\ during the upload feed. Check the response file and correct any issues\
\ mentioned. If the feed fails before processing, no response file is\
\ provided. In this case check the REST output response."
format: "int32"
successCount:
type: "integer"
description: "The number of records that were successfully processed during\
\ the upload feed."
format: "int32"
description: "This container provides summary information on an upload feed\
\ (not applicable for download feed types)."
UserScheduleCollection:
type: "object"
properties:
href:
type: "string"
description: "The path to the call URI that produced the current page of\
\ results."
limit:
type: "integer"
description: "The value of the limit parameter submitted\
\ in the request, which is the maximum number of schedules to return per\
\ page, from the result set. A result set is the complete set of schedules\
\ returned by the method. Note:\
\ Though this parameter is not required to be submitted in the request,\
\ the parameter defaults to 10 if omitted. Note: If this is the last or only page of the result\
\ set, the page may contain fewer tasks than the limit\
\ value. To determine the number of pages in a result set, divide the\
\ total value (total number of tasks matching input criteria) by this\
\ limit value, and then round up to the next integer. For example, if\
\ the total value was 120 (120 total tasks)\
\ and the limit value was 50 (show 50 tasks\
\ per page), the total number of pages in the result set is three, so\
\ the seller would have to make three separate getSchedules\
\ calls to view all tasks matching the input criteria.
Note:\
\ The items in a paginated result set use a zero-based list where\
\ the first item in the list has an offset of 0.
hhZ11ZINACTIVE."
scheduleName:
type: "string"
description: "The schedule name assigned by the user for the created schedule.\
\ Users assign this name for their reference."
scheduleStartDate:
type: "string"
description: "The timestamp that indicates the start of the report generation."
scheduleTemplateId:
type: "string"
description: "The ID of the template used to create this schedule."
schemaVersion:
type: "string"
description: "The schema version of the feedType for the schedule."
status:
type: "string"
description: "The enumeration value that indicates the state of the schedule.\
\ For implementation help, refer to eBay\
\ API documentation"
statusReason:
type: "string"
description: "The reason the schedule is inactive. For implementation help,\
\ refer to eBay\
\ API documentation"
description: "The type that defines the fields for a paginated result set of\
\ available schedules. The response consists of 0 or more sequenced pages\
\ where each page has 0 or more items."
securitySchemes:
api_auth:
type: "oauth2"
description: "The security definitions for this API. Please check individual\
\ operations for applicable scopes."
flows:
authorizationCode:
authorizationUrl: "https://auth.ebay.com/oauth2/authorize"
tokenUrl: "https://api.ebay.com/identity/v1/oauth2/token"
scopes:
https://api.ebay.com/oauth/api_scope/sell.fulfillment: "View and manage\
\ your order fulfillments"
https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly: " This\
\ scope would allow signed in user to read catalog data."
https://api.ebay.com/oauth/api_scope/sell.inventory: "View and manage\
\ your inventory and offers"
https://api.ebay.com/oauth/api_scope/sell.marketing: "View and manage\
\ your eBay marketing activities, such as ad campaigns and listing promotions"
https://api.ebay.com/oauth/api_scope/sell.analytics.readonly: "View your\
\ selling analytics data, such as performance reports"