eBay · Schema

Task

The type that defines the fields for the task details.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
completionDate	string	The timestamp when the task went into the `COMPLETED` or `COMPLETED_WITH_ERROR` state. This state means that eBay has compiled the report for the seller based on the seller’s fil
creationDate	string	The date the task was created.
detailHref	string	The path to the call URI used to retrieve the task. This field points to the GetOrderTask URI if the task is for `LMS_ORDER_REPORT` or will be null if this task is for `LMS_ORDER_ACK`
feedType	string	The feed type associated with the task.
schemaVersion	string	The schema version number associated with the task.
status	string	The enumeration value that indicates the state of the task that was submitted in the request. See FeedStatusEnum for information. The values `COMPLETED` and `COMPLE`
taskId	string	The ID of the task that was submitted in the request.
uploadSummary	object	This container provides summary information on an upload feed (not applicable for download feed types).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Task",
  "title": "Task",
  "type": "object",
  "properties": {
    "completionDate": {
      "type": "string",
      "description": "The timestamp when the task went into the <code>COMPLETED</code> or <code>COMPLETED_WITH_ERROR</code> state. This state means that eBay has compiled the report for the seller based on the seller\u2019s filter criteria, and the seller can run a <strong>getResultFile</strong> 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. This field points to the GetOrderTask URI if the task is for <code>LMS_ORDER_REPORT</code> or will be null if this task is for <code>LMS_ORDER_ACK</code>."
    },
    "feedType": {
      "type": "string",
      "description": "The feed type associated with the task."
    },
    "schemaVersion": {
      "type": "string",
      "description": "The schema version number associated with the task."
    },
    "status": {
      "type": "string",
      "description": "The enumeration value that indicates the state of the task that was submitted in the request. See <strong>FeedStatusEnum</strong> for information. <p>The values <code>COMPLETED </code>and<code> COMPLETED_WITH_ERROR</code> indicate the Order Report file is ready to download.</p> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:FeedStatusEnum'>eBay API documentation</a>"
    },
    "taskId": {
      "type": "string",
      "description": "The ID of the task that was submitted in the request."
    },
    "uploadSummary": {
      "description": "This container provides summary information on an upload feed (not applicable for download feed types).",
      "$ref": "#/components/schemas/UploadSummary"
    }
  },
  "description": "The type that defines the fields for the task details."
}