feed APIv1.1.0

createOrderTask

POST
/order_task
This method creates an order download task with filter criteria for the order report. When using this method, specify the feed_type, 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.

Input

Resource URI (production)

POST https://api.ebay.com/sell/feed/v1/order_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.fulfillment

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

Occurrence: Required

filterCriteriaOrderFilterCriteriaThe container for the filter fields. This container is used to set the filter criteria for the order report. A seller can set date range filters and/or can retrieve orders in a specific state.

Occurrence: Optional

filterCriteria.creationDateRangeDateRangeThe creation date range of the orders you want returned.

Occurrence: Optional

filterCriteria.creationDateRange.fromstringThe beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required.

Format: UTC yyyy-MM-ddThh:mm:ss.SSSZ

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

Occurrence: Conditional

filterCriteria.creationDateRange.tostringThe 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.

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

Occurrence: Conditional

filterCriteria.modifiedDateRangeDateRangeThe modified date range of the orders you want returned.

Occurrence: Optional

filterCriteria.modifiedDateRange.fromstringThe beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required.

Format: UTC yyyy-MM-ddThh:mm:ss.SSSZ

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

Occurrence: Conditional

filterCriteria.modifiedDateRange.tostringThe 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.

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

Occurrence: Conditional

filterCriteria.orderStatusOrderStatusEnumThe order status of the orders returned. If the filter is omitted from createOrderTask call, orders that are in both ACTIVE and COMPLETED states are returned.

Occurrence: Optional

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

Occurrence: Required

Output

HTTP response headers

See HTTP response headers for details.

HeaderMeaning
LocationThe location response header contains the URL to the order task. The URL includes the eBay-assigned task ID, which you can use to reference the order 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 not valid.
160019API_FEEDREQUESTThe 'filterCriteria' is invalid. {additionalInfo}
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 an Order Task

This call creates a task that retrieves the active orders within a date range.

Input

The inputs are feedType, creationDate, modifiedDateRange, and orderStatus.
POST
https://api.ebay.com/sell/feed/v1/order_task

Output

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