Choose a version:

disputeEvidence

query

Returns dispute evidence details based on ID.

Arguments

Anchor to idid • ID!required: The ID of the ShopifyPaymentsDisputeEvidence to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

ShopifyPaymentsDisputeEvidence

•

ShopifyPaymentsDisputeEvidence

The evidence associated with the dispute.

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! non-null: The dispute associated with the evidence.
disputeFileUploads• [ShopifyPaymentsDisputeFileUpload!]! non-null: The file uploads associated with the dispute evidence.
fulfillments• [ShopifyPaymentsDisputeFulfillment!]! non-null: The fulfillments associated with the dispute evidence.
id• ID! non-null: 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! non-null: 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.

Was this section helpful?

Returns evidence associated with the dispute

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query ShopifyPaymentsDisputeEvidenceShow($id: ID!) {

disputeEvidence(id: $id) {

dispute {

amount {

amount

currencyCode

}

evidenceDueBy

evidenceSentOn

finalizedOn

initiatedAt

reasonDetails {

reason

networkReasonCode

}

status

type

}

}`,

{

variables: {

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

);

const data = await response.json();

query ShopifyPaymentsDisputeEvidenceShow($id: ID!) {
  disputeEvidence(id: $id) {
    dispute {
      amount {
        amount
        currencyCode
      }
      evidenceDueBy
      evidenceSentOn
      finalizedOn
      id
      initiatedAt
      reasonDetails {
        reason
        networkReasonCode
      }
      status
      type
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ShopifyPaymentsDisputeEvidenceShow($id: ID!) { disputeEvidence(id: $id) { dispute { amount { amount currencyCode } evidenceDueBy evidenceSentOn finalizedOn id initiatedAt reasonDetails { reason networkReasonCode } status type } } }",
 "variables": {
    "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query ShopifyPaymentsDisputeEvidenceShow($id: ID!) {
    disputeEvidence(id: $id) {
      dispute {
        amount {
          amount
          currencyCode
        }
        evidenceDueBy
        evidenceSentOn
        finalizedOn
        id
        initiatedAt
        reasonDetails {
          reason
          networkReasonCode
        }
        status
        type
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query ShopifyPaymentsDisputeEvidenceShow($id: ID!) {
      disputeEvidence(id: $id) {
        dispute {
          amount {
            amount
            currencyCode
          }
          evidenceDueBy
          evidenceSentOn
          finalizedOn
          id
          initiatedAt
          reasonDetails {
            reason
            networkReasonCode
          }
          status
          type
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671"
    },
  },
});

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
  query ShopifyPaymentsDisputeEvidenceShow($id: ID!) {
    disputeEvidence(id: $id) {
      dispute {
        amount {
          amount
          currencyCode
        }
        evidenceDueBy
        evidenceSentOn
        finalizedOn
        id
        initiatedAt
        reasonDetails {
          reason
          networkReasonCode
        }
        status
        type
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ShopifyPaymentsDisputeEvidence/819974671"
}

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

Input variables

JSON

{

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

}

Response

JSON

{

"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"

}