disputeEvidenceUpdate

Updates the evidence package for a Shopify Payments dispute. Merchants submit evidence — such as shipping confirmations, customer communications, and refund policies — to contest a dispute filed by a cardholder.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the disputeEvidenceUpdate action (under Dispute).
Fill in the fields below, then reference the result from later steps as {{disputeevidenceupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation DisputeEvidenceUpdate($id: ID!, $input: ShopifyPaymentsDisputeEvidenceUpdateInput!) {
  disputeEvidenceUpdate(id: $id, input: $input) {
    disputeEvidence {
      accessActivityLog
      billingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      cancellationPolicyDisclosure
      cancellationPolicyFile {
        disputeEvidenceType
        fileSize
        fileType
        id
        originalFileName
        url
      }
      cancellationRebuttal
      customerCommunicationFile {
        disputeEvidenceType
        fileSize
        fileType
        id
        originalFileName
        url
      }
      customerEmailAddress
      customerFirstName
      customerLastName
      customerPurchaseIp
      dispute {
        amount
        disputeEvidence
        evidenceDueBy
        evidenceSentOn
        finalizedOn
        id
        initiatedAt
        legacyResourceId
        order
        reasonDetails
        status
        type
      }
      disputeFileUploads {
        disputeEvidenceType
        fileSize
        fileType
        id
        originalFileName
        url
      }
      fulfillments {
        id
        shippingCarrier
        shippingDate
        shippingTrackingNumber
      }
      id
      productDescription
      refundPolicyDisclosure
      refundPolicyFile {
        disputeEvidenceType
        fileSize
        fileType
        id
        originalFileName
        url
      }
      refundRefusalExplanation
      serviceDocumentationFile {
        disputeEvidenceType
        fileSize
        fileType
        id
        originalFileName
        url
      }
      shippingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      shippingDocumentationFile {
        disputeEvidenceType
        fileSize
        fileType
        id
        originalFileName
        url
      }
      submitted
      uncategorizedFile {
        disputeEvidenceType
        fileSize
        fileType
        id
        originalFileName
        url
      }
      uncategorizedText
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the dispute evidence to be updated.

inputobjectrequired

The updated properties for a dispute evidence.

customerEmailAddressstring

customerLastNamestring

customerFirstNamestring

shippingAddressobject13 fields

uncategorizedTextstring

accessActivityLogstring

cancellationPolicyDisclosurestring

cancellationRebuttalstring

refundPolicyDisclosurestring

refundRefusalExplanationstring

cancellationPolicyFileobject2 fields

customerCommunicationFileobject2 fields

refundPolicyFileobject2 fields

shippingDocumentationFileobject2 fields

uncategorizedFileobject2 fields

serviceDocumentationFileobject2 fields

submitEvidenceboolean

json

{
  "id": "string",
  "input": {
    "customerEmailAddress": "string",
    "customerLastName": "string",
    "customerFirstName": "string",
    "shippingAddress": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "company": "string",
      "country": "string",
      "countryCode": "AF",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string",
      "province": "string",
      "provinceCode": "string"
    },
    "uncategorizedText": "string",
    "accessActivityLog": "string",
    "cancellationPolicyDisclosure": "string",
    "cancellationRebuttal": "string",
    "refundPolicyDisclosure": "string",
    "refundRefusalExplanation": "string",
    "cancellationPolicyFile": {
      "id": "string",
      "destroy": false
    },
    "customerCommunicationFile": {
      "id": "string",
      "destroy": false
    }
  }
}

Response

Read the result with {{disputeevidenceupdate.response.data.data.disputeEvidenceUpdate}}. If the API returns errors, the step fails and they are at {{disputeevidenceupdate.response.data.errors}}.

disputeEvidenceobject

accessActivityLogstring

billingAddressobject21 fields

cancellationPolicyDisclosurestring

cancellationPolicyFileobject6 fields

cancellationRebuttalstring

customerCommunicationFileobject6 fields

customerEmailAddressstring

customerFirstNamestring

customerLastNamestring

customerPurchaseIpstring

disputeobject12 fields

disputeFileUploadsarray<object>

fulfillmentsarray<object>

idstring

productDescriptionstring

refundPolicyDisclosurestring

refundPolicyFileobject6 fields

refundRefusalExplanationstring

serviceDocumentationFileobject6 fields

shippingAddressobject21 fields

shippingDocumentationFileobject6 fields

submittedboolean

uncategorizedFileobject6 fields

uncategorizedTextstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?