disputeEvidence - admin-graphql - QUERY

Version: 2024-10

Description:

Returns dispute evidence details based on ID.

Access Scopes

Arguments

• id: ID! - The ID of the ShopifyPaymentsDisputeEvidence to return.

Returns

• accessActivityLog: String The activity logs associated with the dispute evidence.
• billingAddress: MailingAddress The billing address that's provided by the customer.
• cancellationPolicyDisclosure: String The cancellation policy disclosure associated with the dispute evidence.
• cancellationPolicyFile: ShopifyPaymentsDisputeFileUpload The cancellation policy file associated with the dispute evidence.
• cancellationRebuttal: String The cancellation rebuttal associated with the dispute evidence.
• customerCommunicationFile: ShopifyPaymentsDisputeFileUpload The customer communication file associated with the dispute evidence.
• customerEmailAddress: String The customer's email address.
• customerFirstName: String The customer's first name.
• customerLastName: String The customer's last name.
• customerPurchaseIp: String The customer purchase ip for this dispute evidence.
• dispute: ShopifyPaymentsDispute! The dispute associated with the evidence.
• disputeFileUploads: ShopifyPaymentsDisputeFileUpload! The file uploads associated with the dispute evidence.
• fulfillments: ShopifyPaymentsDisputeFulfillment! The fulfillments associated with the dispute evidence.
• id: ID! A globally-unique ID.
• productDescription: String The product description for this dispute evidence.
• refundPolicyDisclosure: String The refund policy disclosure associated with the dispute evidence.
• refundPolicyFile: ShopifyPaymentsDisputeFileUpload The refund policy file associated with the dispute evidence.
• refundRefusalExplanation: String The refund refusal explanation associated with dispute evidence.
• serviceDocumentationFile: ShopifyPaymentsDisputeFileUpload The service documentation file associated with the dispute evidence.
• shippingAddress: MailingAddress The mailing address for shipping that's provided by the customer.
• shippingDocumentationFile: ShopifyPaymentsDisputeFileUpload The shipping documentation file associated with the dispute evidence.
• submitted: Boolean! Whether the dispute evidence is submitted.
• uncategorizedFile: ShopifyPaymentsDisputeFileUpload The uncategorized file associated with the dispute evidence.
• uncategorizedText: String The uncategorized text for the dispute evidence.

Examples

• Returns evidence associated with the 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\": \"query ShopifyPaymentsDisputeEvidenceShow($id: ID!) { disputeEvidence(id: $id) { dispute { amount { amount currencyCode } evidenceDueBy evidenceSentOn finalizedOn id initiatedAt reasonDetails { reason networkReasonCode } status type } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query ShopifyPaymentsDisputeEvidenceShow($id: ID!) {\n      disputeEvidence(id: $id) {\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    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\"\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  query ShopifyPaymentsDisputeEvidenceShow($id: ID!) {\n    disputeEvidence(id: $id) {\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  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\"\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];\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  query ShopifyPaymentsDisputeEvidenceShow($id: ID!) {\n    disputeEvidence(id: $id) {\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  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ShopifyPaymentsDisputeEvidence/819974671\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ShopifyPaymentsDisputeEvidenceShow($id: ID!) {\n  disputeEvidence(id: $id) {\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}"
        

  input: {
    "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671"
  }

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