POST/order_task
This method creates an order download task with filter criteria for the order report. When using this method, specify the feedType, schemaVersion, and filterCriteria for the report. The method returns the location response header containing the getOrderTask call URI to retrieve the order task you just created. The URL includes the eBay-assigned task ID, which you can use to reference the order task.
To retrieve the status of the task, use the getOrderTask method to retrieve a single task ID or the getOrderTasks method to retrieve multiple order task IDs.
Note: The scope depends on the feed type. An error message results when an unsupported scope or feed type is specified.
The following list contains this method's authorization scope and its corresponding feed type:
- https://api.ebay.com/oauth/api_scope/sell.fulfillment: LMS_ORDER_REPORT
For details about how this method is used, see General feed types in the Selling Integration Guide.
Note: At this time, the createOrderTask method only supports order creation date filters and not modified order date filters. Do not include the modifiedDateRange filter in your request payload.
Input
Resource URI (production)
URI parameters
This method has no URI parameters.
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| X-EBAY-C-MARKETPLACE-ID | string | The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example:
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.
Request payload
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| feedType | string | The feed type associated with the task. The only presently supported value is Occurrence: Required |
| filterCriteria | OrderFilterCriteria | The 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.creationDateRange | DateRange | The creation date range of the orders you want returned. Set the date range so it contains less than 10 days (maximum). If you do not specify a DateRange, results from the last 10 days will be returned by default. Occurrence: Optional |
| filterCriteria.creationDateRange.from | string | The beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required. Occurrence: Conditional |
| filterCriteria.creationDateRange.to | string | 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. Occurrence: Conditional |
| filterCriteria.modifiedDateRange | DateRange | The modified date range of the orders you want returned. 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. Occurrence: Optional |
| filterCriteria.modifiedDateRange.from | string | The beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required. Occurrence: Conditional |
| filterCriteria.modifiedDateRange.to | string | 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. Occurrence: Conditional |
| filterCriteria.orderStatus | OrderStatusEnum | The order status of the orders returned. If the filter is omitted from createOrderTask call, orders that are in both Occurrence: Optional |
| schemaVersion | string | The schema version of the LMS OrderReport. For the Occurrence: Required |
Output
HTTP response headers
See HTTP response headers for details.
| Header | Meaning |
|---|---|
| Location | The 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. |
Response payload
This call has no payload.
Response fields
This call has no field definitions.
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.
| Status | Meaning |
|---|---|
| 202 | Accepted |
| 400 | Bad Request |
| 403 | Forbidden |
| 409 | Conflict |
| 500 | Internal Server Error |
Error codes
Note: Error Code 160001 may indicate a rate limit error (same as 160024 or 160025). For additional information, see Feed limits.
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 160001 | API_FEED | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. |
| 160002 | API_FEED | REQUEST | The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. |
| 160017 | API_FEED | REQUEST | The 'feedType' is missing or invalid. |
| 160018 | API_FEED | REQUEST | The 'schemaVersion' is invalid. |
| 160019 | API_FEED | REQUEST | The 'filterCriteria' is invalid. {additionalInfo} |
| 160022 | API_FEED | REQUEST | You are not allowed to access this resource. Contact eBay Developer Technical Support for assistance. |
| 160024 | API_FEED | BUSINESS | 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 | API_FEED | BUSINESS | 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. |
| 160027 | API_FEED | REQUEST | The X-EBAY-C-MARKETPLACE-ID header is missing or invalid. |
| 160030 | API_FEED | REQUEST | This resource is not applicable for the feed type {feedTypeValue}. For more information, see the documentation for this API. |
Warnings
This call has no 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 schemaVersion, feedType, creationDateRange, and orderStatus.
POSThttps://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. This method has no response payload.