openapi: 3.0.0 info: title: eBay Account Advertising_eligibility Task API description: The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.

For details on the availability of the methods in this API, see Account API requirements and restrictions. contact: name: eBay Inc, license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement version: v1.9.2 servers: - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /sell/account/v1 tags: - name: Task paths: /task: get: tags: - Task description: 'This method returns the details and status for an array of tasks based on a specified 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.


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' 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: 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.' required: false schema: type: string - name: limit in: query description: 'The maximum number of tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the 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' 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: '160004': domain: API_FEED category: REQUEST description: You must submit either a 'feed_type' or 'schedule_id'. '160005': domain: API_FEED category: REQUEST description: Both 'feed_type' and 'schedule_id' were provided. Please remove one of them. '160006': domain: API_FEED category: REQUEST description: The 'feed_type' {feedTypeValue} is invalid. '160007': domain: API_FEED category: REQUEST description: The 'schedule_id' {scheduleID} is invalid. '160008': domain: API_FEED category: REQUEST description: Both 'look_back_days' and 'date_range' were provided. Please remove one of them. '160009': domain: API_FEED category: REQUEST description: The format of the 'date_range' is invalid. The format for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ. '160010': domain: API_FEED category: REQUEST description: The 'date_range' must be less than or equal to 90 days. '160011': domain: API_FEED category: REQUEST description: The 'look_back_days' value must be greater than zero and less than or equal to 90. '160012': domain: API_FEED category: REQUEST description: The 'limit' value must be greater than zero and less than or equal to 500. '160013': domain: API_FEED category: REQUEST description: The 'offset' value cannot be less than zero. '160016': domain: API_FEED category: REQUEST description: The 'date_range' value is not valid. Ensure that the beginning of the range is before the end of the range. '160029': domain: API_FEED category: REQUEST description: The 'offset' value must be a multiple of the 'limit' value. '403': description: Forbidden x-response-codes: errors: '160002': domain: API_FEED category: REQUEST description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. '500': description: Internal Server Error x-response-codes: errors: '160001': domain: API_FEED category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory - https://api.ebay.com/oauth/api_scope/sell.fulfillment - https://api.ebay.com/oauth/api_scope/sell.marketing - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly post: tags: - Task description: 'This method creates an upload task or a download task without filter criteria. When using this method, specify the 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:

* 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.

For example:

X-EBAY-C-MARKETPLACE-ID:EBAY_US

This identifies the eBay marketplace that applies to this task. See MarketplaceIdEnum for supported values.

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.

For more information, refer to HTTP request headers. required: true schema: type: string requestBody: description: description not needed content: application/json: schema: description: description not needed $ref: '#/components/schemas/CreateTaskRequest' required: true responses: '202': description: Accepted '400': description: Bad Request x-response-codes: errors: '160017': domain: API_FEED category: REQUEST description: The 'feedType' is missing or invalid. '160018': domain: API_FEED category: REQUEST description: The 'schemaVersion' is invalid. '160027': domain: API_FEED category: REQUEST description: The X-EBAY-C-MARKETPLACE-ID header is missing or invalid. '160030': domain: API_FEED category: REQUEST description: This resource is not applicable for the feed type {feedTypeValue}. For more information, see the documentation for this API. '403': description: Forbidden x-response-codes: errors: '160002': domain: API_FEED category: REQUEST description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. '160022': domain: API_FEED category: REQUEST description: You are not allowed to access this resource. Contact eBay Developer Technical Support for assistance. '409': description: Conflict x-response-codes: errors: '160024': domain: API_FEED category: BUSINESS description: You have reached the maximum number of feed tasks that can be queued or processed concurrently. Wait for current tasks to complete before adding tasks. For more information, see the documentation for this API. '160025': domain: API_FEED category: BUSINESS description: You have exceeded the maximum number of records or tasks that can be created or processed in the period (hourly or daily). Wait until the present period ends before trying again. Please reference the API documentation for more information. '500': description: Internal Server Error x-response-codes: errors: '160001': domain: API_FEED category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory - https://api.ebay.com/oauth/api_scope/sell.fulfillment - https://api.ebay.com/oauth/api_scope/sell.marketing - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly /task/{task_id}/download_input_file: get: tags: - Task description: This method downloads the file previously uploaded using 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.

operationId: getInputFile parameters: - name: task_id in: path description: This path parameter is the unique identifier of the task associated with the input file to be downloaded.

Use the getTasks method to retrieve task IDs. required: true schema: type: string responses: '200': description: Success headers: content-disposition: schema: type: string description: Returns metadata for the downloaded file. content: application/octet-stream: schema: $ref: '#/components/schemas/StreamingOutput' '400': description: Bad Request '403': description: Forbidden x-response-codes: errors: '160002': domain: API_FEED category: REQUEST description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. '404': description: Not Found x-response-codes: errors: '160003': domain: API_FEED category: REQUEST description: Task {taskID} does not exist. '160014': domain: API_FEED category: REQUEST description: No file found for task ID {taskID}. '160015': domain: API_FEED category: REQUEST description: 'The ''task_id'' {taskID} is a download task, which in invalid for an input file. ' '500': description: Internal Server Error x-response-codes: errors: '160001': domain: API_FEED category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory - https://api.ebay.com/oauth/api_scope/sell.fulfillment - https://api.ebay.com/oauth/api_scope/sell.marketing - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly /task/{task_id}/download_result_file: get: tags: - Task description: 'This method retrieves the generated file that is associated with the specified task ID. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz).

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.

' operationId: getResultFile parameters: - name: task_id in: path description: This path parameter is the unique identifier of the task associated with the file to be downloaded.

Use the getTasks method to retrieve task IDs. required: true schema: type: string responses: '200': description: Success headers: content-disposition: schema: type: string description: Returns metadata for the downloaded file. content: application/octet-stream: schema: $ref: '#/components/schemas/StreamingOutput' '400': description: Bad Request '403': description: Forbidden x-response-codes: errors: '160002': domain: API_FEED category: REQUEST description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. '404': description: Not Found x-response-codes: errors: '160003': domain: API_FEED category: REQUEST description: Task {taskID} does not exist. '160014': domain: API_FEED category: REQUEST description: No file found for task ID {taskID}. '500': description: Internal Server Error x-response-codes: errors: '160001': domain: API_FEED category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory - https://api.ebay.com/oauth/api_scope/sell.fulfillment - https://api.ebay.com/oauth/api_scope/sell.marketing - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly /task/{task_id}: get: tags: - Task description: 'This method retrieves the details and status of the specified task. The input is task_id.

For details of how this method is used, see Working with Order Feeds in the Selling Integration Guide. ' operationId: getTask parameters: - name: task_id in: path description: This path parameter is the unique identifier of the task being retrieved.

Use the getTasks method to retrieve task IDs. required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Task' '400': description: Bad Request '403': description: Forbidden x-response-codes: errors: '160002': domain: API_FEED category: REQUEST description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. '404': description: Not Found x-response-codes: errors: '160003': domain: API_FEED category: REQUEST description: Task {taskID} does not exist. '500': description: Internal Server Error x-response-codes: errors: '160001': domain: API_FEED category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory - https://api.ebay.com/oauth/api_scope/sell.fulfillment - https://api.ebay.com/oauth/api_scope/sell.marketing - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly /task/{task_id}/upload_file: post: tags: - Task description: 'This method associates the specified file with the specified task ID and uploads the input file. After the file has been uploaded, the processing of the file begins.

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).

' 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.

Use the getTasks method to retrieve task IDs. required: true schema: type: string - name: Content-Type in: header description: This header indicates the format of the request body provided by the client. Its value should be set to multipart/form-data.

For more information, refer to HTTP request headers. required: true schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad Request x-response-codes: errors: '160020': domain: API_FEED category: REQUEST description: The format of the file to be uploaded is invalid. {additionalInfo} '160023': domain: API_FEED category: REQUEST description: Task {taskID} cannot upload a file. '160026': domain: API_FEED category: REQUEST description: This task has expired and you cannot use it to upload a file. You must upload a file within a hour of creating the task. '160028': domain: API_FEED category: REQUEST description: The file you tried to upload is too large. Please try using a smaller file. For more information, see the documentation for this API. '160100': domain: API_FEED category: REQUEST description: Payload not found. Make sure your file is uploaded inside the Request Body under the key name 'file'. '403': description: Forbidden x-response-codes: errors: '160002': domain: API_FEED category: REQUEST description: The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. '404': description: Not Found x-response-codes: errors: '160003': domain: API_FEED category: REQUEST description: Task {taskID} does not exist. '500': description: Internal Server Error x-response-codes: errors: '160001': domain: API_FEED category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory - https://api.ebay.com/oauth/api_scope/sell.fulfillment - https://api.ebay.com/oauth/api_scope/sell.marketing - https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly - https://api.ebay.com/oauth/api_scope/sell.analytics.readonly components: schemas: 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). CreateTaskRequest: type: object properties: feedType: type: string description: The feed type associated with the task. Available feed types:
schemaVersion: type: string description: The schemaVersion/version number of the file format:
description: The type that defines the fields for the createTask method. StreamingOutput: type: object description: File stream Task: 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. 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.

For implementation help, refer to eBay API documentation taskId: type: string description: The ID of the task that was submitted in the request. uploadSummary: description: This container provides summary information on an upload feed (not applicable for download feed types). $ref: '#/components/schemas/UploadSummary' description: The type that defines the fields for the task details. TaskCollection: type: object properties: href: type: string description: 'The path to the call URI that produced the current page of results. ' limit: type: integer description: The value of the 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: 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.

format: int32 next: type: string description: The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. offset: type: integer description: 'The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

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.

' format: int32 prev: type: string description: The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set. tasks: type: array description: 'An array of the tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks. ' items: $ref: '#/components/schemas/Task' total: type: integer description: The total number of tasks that match the input criteria. format: int32 description: The type that defines the fields for a paginated result set of tasks. The response consists of 0 or more sequenced 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.account.readonly: View your account settings https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings