disputeEvidenceUpdate

mutation

Requires write_shopify_payments_dispute_evidences access scope. Also: The user must have manage_orders_information permission.

Updates a dispute evidence.

Arguments

Anchor to idid • ID!required: The ID of the dispute evidence to be updated.
Anchor to inputinput • ShopifyPaymentsDisputeEvidenceUpdateInput!required: The updated properties for a dispute evidence.

Was this section helpful?

Anchor to DisputeEvidenceUpdatePayload returnsDisputeEvidenceUpdatePayload returns

Anchor to disputeEvidencedisputeEvidence • ShopifyPaymentsDisputeEvidence: The updated dispute evidence.
Anchor to userErrorsuserErrors • [DisputeEvidenceUpdateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete a dispute evidence file
Updates dispute evidence
Upload a file to a dispute
disputeEvidenceUpdate reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) {

disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) {

disputeEvidence {

disputeFileUploads {

}

dispute {

amount {

amount

currencyCode

}

evidenceDueBy

evidenceSentOn

finalizedOn

initiatedAt

reasonDetails {

reason

networkReasonCode

}

mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) {
  disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) {
    disputeEvidence {
      disputeFileUploads {
        id
      }
      dispute {
        amount {
          amount
          currencyCode
        }
        evidenceDueBy
        evidenceSentOn
        finalizedOn
        id
        initiatedAt
        reasonDetails {
          reason
          networkReasonCode
        }
        status
        type
      }
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) { disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) { disputeEvidence { disputeFileUploads { id } dispute { amount { amount currencyCode } evidenceDueBy evidenceSentOn finalizedOn id initiatedAt reasonDetails { reason networkReasonCode } status type } } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671",
    "fileId": "gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) {
    disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) {
      disputeEvidence {
        disputeFileUploads {
          id
        }
        dispute {
          amount {
            amount
            currencyCode
          }
          evidenceDueBy
          evidenceSentOn
          finalizedOn
          id
          initiatedAt
          reasonDetails {
            reason
            networkReasonCode
          }
          status
          type
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671",
      "fileId": "gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) {
      disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) {
        disputeEvidence {
          disputeFileUploads {
            id
          }
          dispute {
            amount {
              amount
              currencyCode
            }
            evidenceDueBy
            evidenceSentOn
            finalizedOn
            id
            initiatedAt
            reasonDetails {
              reason
              networkReasonCode
            }
            status
            type
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671",
      "fileId": "gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) {
    disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) {
      disputeEvidence {
        disputeFileUploads {
          id
        }
        dispute {
          amount {
            amount
            currencyCode
          }
          evidenceDueBy
          evidenceSentOn
          finalizedOn
          id
          initiatedAt
          reasonDetails {
            reason
            networkReasonCode
          }
          status
          type
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671",
  "fileId": "gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671",

"fileId": "gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523"

}

Response

JSON

{

"disputeEvidenceUpdate": {

"disputeEvidence": {

"disputeFileUploads": [],

"dispute": {

"amount": {

"amount": "11.5",

"currencyCode": "USD"

"evidenceDueBy": "2024-11-20T19:00:00-05:00",

"evidenceSentOn": null,

"finalizedOn": null,

"id": "gid://shopify/ShopifyPaymentsDispute/598735659",

"initiatedAt": "2013-05-04T00:00:00Z",

"reasonDetails": {

"reason": "FRAUDULENT",

"networkReasonCode": "4827"

"status": "NEEDS_RESPONSE",

"type": "CHARGEBACK"

}

"userErrors": []

}