eBay · Schema

DisputeEvidence

This type is used by the evidence array that is returned in the getPaymentDispute response if one or more evidential documents are associated with the payment dispute.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
evidenceId string Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file wit
evidenceType string This enumeration value shows the type of evidential file provided. For implementation help, refer to eBay API
files array This array shows the name, ID, file type, and upload date for each provided file.
lineItems array This array shows one or more order line items associated with the evidential document that has been provided.
providedDate string The timestamp in this field shows the date/time when the seller provided a requested evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and time format, an
requestDate string The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute.

The timestamps returned here use the ISO-8601 24-h
respondByDate string The timestamp in this field shows the date/time when the seller was expected to provide a requested evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and
shipmentTracking array This array shows the shipping carrier and shipment tracking number associated with each shipment package of the order. This array is returned under the evidence container if the selle
View JSON Schema on GitHub

JSON Schema

ebay-disputeevidence-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DisputeEvidence",
  "title": "DisputeEvidence",
  "type": "object",
  "properties": {
    "evidenceId": {
      "type": "string",
      "description": "Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set."
    },
    "evidenceType": {
      "type": "string",
      "description": "This enumeration value shows the type of evidential file provided. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:EvidenceTypeEnum'>eBay API documentation</a>"
    },
    "files": {
      "type": "array",
      "description": "This array shows the name, ID, file type, and upload date for each provided file.",
      "items": {
        "$ref": "#/components/schemas/FileInfo"
      }
    },
    "lineItems": {
      "type": "array",
      "description": "This array shows one or more order line items associated with the evidential document that has been provided.",
      "items": {
        "$ref": "#/components/schemas/OrderLineItems"
      }
    },
    "providedDate": {
      "type": "string",
      "description": "The timestamp in this field shows the date/time when the seller provided a requested evidential document to eBay. <br><br>The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example would be <code>2019-08-04T19:09:02.768Z</code>."
    },
    "requestDate": {
      "type": "string",
      "description": "The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. <br><br>The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example would be <code>2019-08-04T19:09:02.768Z</code>."
    },
    "respondByDate": {
      "type": "string",
      "description": "The timestamp in this field shows the date/time when the seller was expected to provide a requested evidential document to eBay.  <br><br>The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example would be <code>2019-08-04T19:09:02.768Z</code>."
    },
    "shipmentTracking": {
      "type": "array",
      "description": "This array shows the shipping carrier and shipment tracking number associated with each shipment package of the order. This array is returned under the <strong>evidence</strong> container if the seller has provided shipment tracking information as evidence to support <code>PROOF_OF_DELIVERY</code> for an INR-related payment dispute.",
      "items": {
        "$ref": "#/components/schemas/TrackingInfo"
      }
    }
  },
  "description": "This type is used by the <strong>evidence</strong> array that is returned in the <strong>getPaymentDispute</strong> response if one or more evidential documents are associated with the payment dispute. "
}