feed APIv1.1.0

createTask

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: None*
  • https://api.ebay.com/oauth/api_scope/sell.fulfillment: LMS_ORDER_ACK (specify for upload tasks), LMS_ORDER_REPORT (specify for download tasks)
  • https://api.ebay.com/oauth/api_scope/sell.marketing: None*
  • https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly: None*

* Reserved for future release

Input

Resource URI (production)

POST https://api.ebay.com/sell/feed/v1/task

URI parameters

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThe ID of the eBay marketplace where the item is hosted.

Note: This value is case sensitive.

For example:

X-EBAY-C-MARKETPLACE-ID = EBAY_US

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

Occurrence: Strongly Recommended

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

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

See OAuth access tokens for more information.

Input container/fieldTypeDescription
feedTypestringThe feed type associated with the task. The only presently supported value is LMS_ORDER_ACK.

Occurrence: Required

schemaVersionstringThe schemaVersion version number of the file format. Acceptable value: 1.0

Occurrence: Optional

Output

HTTP response headers

See HTTP response headers for details.

HeaderMeaning
LocationThe location response header contains the URL to the order report. The URL includes the eBay-assigned task ID, which you can use to reference this task.

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
202Accepted
400Bad Request
403Forbidden
409Conflict
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
160001API_FEEDAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
160002API_FEEDREQUESTThe authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
160017API_FEEDREQUESTThe 'feedType' is missing or invalid.
160018API_FEEDREQUESTThe 'schemaVersion' is invalid.
160022API_FEEDREQUESTYou are not allowed to access this resource. Contact eBay Developer Technical Support for assistance.
160024API_FEEDBUSINESSYou 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.
160025API_FEEDBUSINESSYou have exceeded the maximum number of feed tasks that can be created or processed in a given period (hour or day). Wait until the present period ends before adding tasks. For more information, see the documentation for this API.
160027API_FEEDREQUESTX-EBAY-C-MARKETPLACE-ID header is missing or invalid.
160030API_FEEDREQUESTThis resource is not applicable for the feed type {feedTypeValue}. For more information, see the documentation for this API.

Warnings

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Create Task

This call creates an upload task for a file with information that acknowledges the orders you have already received. After this task has been created (status = CREATED), you can use the uploadFile method to upload the acknowlegement file.

Input

The input is feedType and schemaVersion.
POST
https://api.ebay.com/sell/feed/v1/task

Output

The output is an HTTP status. If the call is successful, the task ID is returned in the Location response header.