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:
'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.
'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.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.
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.
' operationId: createOrderTask 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.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.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.
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. 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.
OrderFilterCriteria:
type: object
properties:
creationDateRange:
description: 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.
$ref: '#/components/schemas/DateRange'
modifiedDateRange:
description: 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.
$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.
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