eBay · Schema

CreateOrderTaskRequest

The type that defines the fields for the createOrderTask request.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
feedType	string	The feed type associated with the task. The only presently supported value is `LMS_ORDER_REPORT`. See filterCriteria	object	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.
schemaVersion	string	The schema version of the LMS OrderReport. For the `LMS_ORDER_REPORT` feed type, see the OrderReport reference page

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateOrderTaskRequest",
  "title": "CreateOrderTaskRequest",
  "type": "object",
  "properties": {
    "feedType": {
      "type": "string",
      "description": "The feed type associated with the task. The only presently supported value is <code>LMS_ORDER_REPORT</code>.<br><br>See <a href=\"/api-docs/sell/static/feed/lms-feeds-quick-reference.html#merchant-data-reports-download-feed-types\" target=\"_blank\">Report download feed types</a> for more information."
    },
    "filterCriteria": {
      "description": "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.",
      "$ref": "#/components/schemas/OrderFilterCriteria"
    },
    "schemaVersion": {
      "type": "string",
      "description": "The schema version of the LMS OrderReport. For the <code>LMS_ORDER_REPORT</code> feed type, see the <a href=\"/devzone/merchant-data/CallRef/OrderReport.html#OrderReport\">OrderReport</a> reference page to see the present schema version. The <b> schemaVersion</b> value is the version number shown at the top of the <b> OrderReport</b> page. <br /><br /><b>Restriction: </b> 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'."
    }
  },
  "description": "The type that defines the fields for the <b> createOrderTask</b> request."
}