eBay · Schema

UpdateEvidencePaymentDisputeRequest

This type is used by the request payload of the updateEvidence method. The updateEvidence method is used to update an existing evidence set against a payment dispute with one or more evidence files.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
evidenceId string The unique identifier of the evidence set that is being updated with new evidence files.

This ID is returned under the evidence array in the evidenceType		 string This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this
files array This array is used to specify one or more evidence files that will be added to the evidence set associated with a payment dispute. At least one evidence file must be specified in the files
lineItems array This required array identifies the order line item(s) for which the evidence file(s) will be applicable.

These values are returned under the evidenceRequests.lineItems array i
View JSON Schema on GitHub

JSON Schema

ebay-updateevidencepaymentdisputerequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateEvidencePaymentDisputeRequest",
  "title": "UpdateEvidencePaymentDisputeRequest",
  "type": "object",
  "properties": {
    "evidenceId": {
      "type": "string",
      "description": "The unique identifier of the evidence set that is being updated with new evidence files.<br><br> This ID is returned under the <strong>evidence</strong> array in the <a href=\"/api-docs/sell/fulfillment/resources/payment_dispute/methods/getPaymentDispute\" target=\"_blank \">getPaymentDispute</a> response."
    },
    "evidenceType": {
      "type": "string",
      "description": "This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field.<br><br>See the <a href=\"/api-docs/sell/fulfillment/types/api:EvidenceTypeEnum\" target=\"_blank \">EvidenceTypeEnum</a> type for the supported evidence types. 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 is used to specify one or more evidence files that will be added to the evidence set associated with a payment dispute. At least one evidence file must be specified in the <strong>files</strong> array.<br><br> The unique identifier of an evidence file is returned in the response payload of the <strong>uploadEvidence</strong> method.",
      "items": {
        "$ref": "#/components/schemas/FileEvidence"
      }
    },
    "lineItems": {
      "type": "array",
      "description": "This required array identifies the order line item(s) for which the evidence file(s) will be applicable. <br><Br>These values are returned under the <strong>evidenceRequests.lineItems</strong> array in the <a href=\"/api-docs/sell/fulfillment/resources/payment_dispute/methods/getPaymentDispute\" target=\"_blank \">getPaymentDispute</a> response. <br><br><span class=\"tablenote\"><b>Note:</b> Both the <strong>itemId</strong> and <strong>lineItemID</strong> fields are needed to identify each order line item.</span>",
      "items": {
        "$ref": "#/components/schemas/OrderLineItems"
      }
    }
  },
  "description": "This type is used by the request payload of the <strong>updateEvidence</strong> method. The <strong>updateEvidence</strong> method is used to update an existing evidence set against a payment dispute with one or more evidence files."
}