disputeEvidenceUpdate - admin-graphql - MUTATION

Version: 2024-10

Description:

Updates a dispute evidence.

Access Scopes

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

Arguments

• id: ID! - The ID of the dispute evidence to be updated.
• input: ShopifyPaymentsDisputeEvidenceUpdateInput! - The updated properties for a dispute evidence.

Returns

• disputeEvidence: ShopifyPaymentsDisputeEvidence The updated dispute evidence.
• userErrors: DisputeEvidenceUpdateUserError! The list of errors that occurred from executing the mutation.

Examples

• Delete a dispute evidence file

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n    \"fileId\": \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) {\n      disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) {\n        disputeEvidence {\n          disputeFileUploads {\n            id\n          }\n          dispute {\n            amount {\n              amount\n              currencyCode\n            }\n            evidenceDueBy\n            evidenceSentOn\n            finalizedOn\n            id\n            initiatedAt\n            reasonDetails {\n              reason\n              networkReasonCode\n            }\n            status\n            type\n          }\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n      \"fileId\": \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) {\n    disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) {\n      disputeEvidence {\n        disputeFileUploads {\n          id\n        }\n        dispute {\n          amount {\n            amount\n            currencyCode\n          }\n          evidenceDueBy\n          evidenceSentOn\n          finalizedOn\n          id\n          initiatedAt\n          reasonDetails {\n            reason\n            networkReasonCode\n          }\n          status\n          type\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n  \"fileId\": \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n  \"fileId\" => \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) {\n    disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) {\n      disputeEvidence {\n        disputeFileUploads {\n          id\n        }\n        dispute {\n          amount {\n            amount\n            currencyCode\n          }\n          evidenceDueBy\n          evidenceSentOn\n          finalizedOn\n          id\n          initiatedAt\n          reasonDetails {\n            reason\n            networkReasonCode\n          }\n          status\n          type\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n      \"fileId\": \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation ShopifyPaymentsDisputeFileUploadDestroy($id: ID!, $fileId: ID!) {\n  disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId, destroy: true}}) {\n    disputeEvidence {\n      disputeFileUploads {\n        id\n      }\n      dispute {\n        amount {\n          amount\n          currencyCode\n        }\n        evidenceDueBy\n        evidenceSentOn\n        finalizedOn\n        id\n        initiatedAt\n        reasonDetails {\n          reason\n          networkReasonCode\n        }\n        status\n        type\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "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": []
      }
    }
  }

  Updates dispute evidence

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation ShopifyPaymentsDisputeEvidenceUpdate($id: ID!, $input: ShopifyPaymentsDisputeEvidenceUpdateInput!) { disputeEvidenceUpdate(id: $id, input: $input) { disputeEvidence { uncategorizedText dispute { amount { amount currencyCode } evidenceDueBy evidenceSentOn finalizedOn id initiatedAt reasonDetails { reason networkReasonCode } status type } } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n    \"input\": {\n      \"customerFirstName\": \"Kermit\",\n      \"customerLastName\": \"The frog\",\n      \"customerEmailAddress\": \"kermit@example.com\",\n      \"shippingAddress\": {\n        \"address1\": \"1 Infinite Loop\",\n        \"address2\": \"Muppet Studio\",\n        \"city\": \"Cupertino\",\n        \"zip\": \"95014\",\n        \"country\": \"US\",\n        \"province\": \"California\"\n      },\n      \"uncategorizedText\": \"Test uncategorized text\",\n      \"accessActivityLog\": \"Test access activity log\",\n      \"cancellationPolicyDisclosure\": \"Test cancellation policy disclosure\",\n      \"cancellationRebuttal\": \"Test cancellation rebuttal\",\n      \"refundPolicyDisclosure\": \"Test refund policy disclosure\",\n      \"refundRefusalExplanation\": \"Test refund refusal explanation\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation ShopifyPaymentsDisputeEvidenceUpdate($id: ID!, $input: ShopifyPaymentsDisputeEvidenceUpdateInput!) {\n      disputeEvidenceUpdate(id: $id, input: $input) {\n        disputeEvidence {\n          uncategorizedText\n          dispute {\n            amount {\n              amount\n              currencyCode\n            }\n            evidenceDueBy\n            evidenceSentOn\n            finalizedOn\n            id\n            initiatedAt\n            reasonDetails {\n              reason\n              networkReasonCode\n            }\n            status\n            type\n          }\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n      \"input\": {\n        \"customerFirstName\": \"Kermit\",\n        \"customerLastName\": \"The frog\",\n        \"customerEmailAddress\": \"kermit@example.com\",\n        \"shippingAddress\": {\n          \"address1\": \"1 Infinite Loop\",\n          \"address2\": \"Muppet Studio\",\n          \"city\": \"Cupertino\",\n          \"zip\": \"95014\",\n          \"country\": \"US\",\n          \"province\": \"California\"\n        },\n        \"uncategorizedText\": \"Test uncategorized text\",\n        \"accessActivityLog\": \"Test access activity log\",\n        \"cancellationPolicyDisclosure\": \"Test cancellation policy disclosure\",\n        \"cancellationRebuttal\": \"Test cancellation rebuttal\",\n        \"refundPolicyDisclosure\": \"Test refund policy disclosure\",\n        \"refundRefusalExplanation\": \"Test refund refusal explanation\"\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation ShopifyPaymentsDisputeEvidenceUpdate($id: ID!, $input: ShopifyPaymentsDisputeEvidenceUpdateInput!) {\n    disputeEvidenceUpdate(id: $id, input: $input) {\n      disputeEvidence {\n        uncategorizedText\n        dispute {\n          amount {\n            amount\n            currencyCode\n          }\n          evidenceDueBy\n          evidenceSentOn\n          finalizedOn\n          id\n          initiatedAt\n          reasonDetails {\n            reason\n            networkReasonCode\n          }\n          status\n          type\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n  \"input\": {\n    \"customerFirstName\": \"Kermit\",\n    \"customerLastName\": \"The frog\",\n    \"customerEmailAddress\": \"kermit@example.com\",\n    \"shippingAddress\": {\n      \"address1\": \"1 Infinite Loop\",\n      \"address2\": \"Muppet Studio\",\n      \"city\": \"Cupertino\",\n      \"zip\": \"95014\",\n      \"country\": \"US\",\n      \"province\": \"California\"\n    },\n    \"uncategorizedText\": \"Test uncategorized text\",\n    \"accessActivityLog\": \"Test access activity log\",\n    \"cancellationPolicyDisclosure\": \"Test cancellation policy disclosure\",\n    \"cancellationRebuttal\": \"Test cancellation rebuttal\",\n    \"refundPolicyDisclosure\": \"Test refund policy disclosure\",\n    \"refundRefusalExplanation\": \"Test refund refusal explanation\"\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n  \"input\" => [\n    \"customerFirstName\" => \"Kermit\",\n    \"customerLastName\" => \"The frog\",\n    \"customerEmailAddress\" => \"kermit@example.com\",\n    \"shippingAddress\" => [\n      \"address1\" => \"1 Infinite Loop\",\n      \"address2\" => \"Muppet Studio\",\n      \"city\" => \"Cupertino\",\n      \"zip\" => \"95014\",\n      \"country\" => \"US\",\n      \"province\" => \"California\",\n    ],\n    \"uncategorizedText\" => \"Test uncategorized text\",\n    \"accessActivityLog\" => \"Test access activity log\",\n    \"cancellationPolicyDisclosure\" => \"Test cancellation policy disclosure\",\n    \"cancellationRebuttal\" => \"Test cancellation rebuttal\",\n    \"refundPolicyDisclosure\" => \"Test refund policy disclosure\",\n    \"refundRefusalExplanation\" => \"Test refund refusal explanation\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation ShopifyPaymentsDisputeEvidenceUpdate($id: ID!, $input: ShopifyPaymentsDisputeEvidenceUpdateInput!) {\n    disputeEvidenceUpdate(id: $id, input: $input) {\n      disputeEvidence {\n        uncategorizedText\n        dispute {\n          amount {\n            amount\n            currencyCode\n          }\n          evidenceDueBy\n          evidenceSentOn\n          finalizedOn\n          id\n          initiatedAt\n          reasonDetails {\n            reason\n            networkReasonCode\n          }\n          status\n          type\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n      \"input\": {\n        \"customerFirstName\": \"Kermit\",\n        \"customerLastName\": \"The frog\",\n        \"customerEmailAddress\": \"kermit@example.com\",\n        \"shippingAddress\": {\n          \"address1\": \"1 Infinite Loop\",\n          \"address2\": \"Muppet Studio\",\n          \"city\": \"Cupertino\",\n          \"zip\": \"95014\",\n          \"country\": \"US\",\n          \"province\": \"California\"\n        },\n        \"uncategorizedText\": \"Test uncategorized text\",\n        \"accessActivityLog\": \"Test access activity log\",\n        \"cancellationPolicyDisclosure\": \"Test cancellation policy disclosure\",\n        \"cancellationRebuttal\": \"Test cancellation rebuttal\",\n        \"refundPolicyDisclosure\": \"Test refund policy disclosure\",\n        \"refundRefusalExplanation\": \"Test refund refusal explanation\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation ShopifyPaymentsDisputeEvidenceUpdate($id: ID!, $input: ShopifyPaymentsDisputeEvidenceUpdateInput!) {\n  disputeEvidenceUpdate(id: $id, input: $input) {\n    disputeEvidence {\n      uncategorizedText\n      dispute {\n        amount {\n          amount\n          currencyCode\n        }\n        evidenceDueBy\n        evidenceSentOn\n        finalizedOn\n        id\n        initiatedAt\n        reasonDetails {\n          reason\n          networkReasonCode\n        }\n        status\n        type\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671",
    "input": {
      "customerFirstName": "Kermit",
      "customerLastName": "The frog",
      "customerEmailAddress": "kermit@example.com",
      "shippingAddress": {
        "address1": "1 Infinite Loop",
        "address2": "Muppet Studio",
        "city": "Cupertino",
        "zip": "95014",
        "country": "US",
        "province": "California"
      },
      "uncategorizedText": "Test uncategorized text",
      "accessActivityLog": "Test access activity log",
      "cancellationPolicyDisclosure": "Test cancellation policy disclosure",
      "cancellationRebuttal": "Test cancellation rebuttal",
      "refundPolicyDisclosure": "Test refund policy disclosure",
      "refundRefusalExplanation": "Test refund refusal explanation"
    }
  }

  response: {
    "data": {
      "disputeEvidenceUpdate": {
        "disputeEvidence": {
          "uncategorizedText": "Test uncategorized text",
          "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": []
      }
    }
  }

  Upload a file to a dispute

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation ShopifyPaymentsDisputeFileUpload($id: ID!, $fileId: ID!) { disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId}}) { disputeEvidence { disputeFileUploads { id } dispute { amount { amount currencyCode } evidenceDueBy evidenceSentOn finalizedOn id initiatedAt reasonDetails { reason networkReasonCode } status type } } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n    \"fileId\": \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation ShopifyPaymentsDisputeFileUpload($id: ID!, $fileId: ID!) {\n      disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId}}) {\n        disputeEvidence {\n          disputeFileUploads {\n            id\n          }\n          dispute {\n            amount {\n              amount\n              currencyCode\n            }\n            evidenceDueBy\n            evidenceSentOn\n            finalizedOn\n            id\n            initiatedAt\n            reasonDetails {\n              reason\n              networkReasonCode\n            }\n            status\n            type\n          }\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n      \"fileId\": \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation ShopifyPaymentsDisputeFileUpload($id: ID!, $fileId: ID!) {\n    disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId}}) {\n      disputeEvidence {\n        disputeFileUploads {\n          id\n        }\n        dispute {\n          amount {\n            amount\n            currencyCode\n          }\n          evidenceDueBy\n          evidenceSentOn\n          finalizedOn\n          id\n          initiatedAt\n          reasonDetails {\n            reason\n            networkReasonCode\n          }\n          status\n          type\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n  \"fileId\": \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n  \"fileId\" => \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation ShopifyPaymentsDisputeFileUpload($id: ID!, $fileId: ID!) {\n    disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId}}) {\n      disputeEvidence {\n        disputeFileUploads {\n          id\n        }\n        dispute {\n          amount {\n            amount\n            currencyCode\n          }\n          evidenceDueBy\n          evidenceSentOn\n          finalizedOn\n          id\n          initiatedAt\n          reasonDetails {\n            reason\n            networkReasonCode\n          }\n          status\n          type\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\",\n      \"fileId\": \"gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation ShopifyPaymentsDisputeFileUpload($id: ID!, $fileId: ID!) {\n  disputeEvidenceUpdate(id: $id, input: {uncategorizedFile: {id: $fileId}}) {\n    disputeEvidence {\n      disputeFileUploads {\n        id\n      }\n      dispute {\n        amount {\n          amount\n          currencyCode\n        }\n        evidenceDueBy\n        evidenceSentOn\n        finalizedOn\n        id\n        initiatedAt\n        reasonDetails {\n          reason\n          networkReasonCode\n        }\n        status\n        type\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "disputeEvidenceUpdate": {
        "disputeEvidence": {
          "disputeFileUploads": [
            {
              "id": "gid://shopify/ShopifyPaymentsDisputeFileUpload/567271523"
            }
          ],
          "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": []
      }
    }
  }