dispute

query

Returns dispute details based on ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to ShopifyPaymentsDisputeShopifyPaymentsDispute • ShopifyPaymentsDispute: A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.

Was this section helpful?

Return a single dispute

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query ShopifyPaymentsDisputesShow($id: ID!) {
6    dispute(id: $id) {
7      amount {
8        amount
9        currencyCode
10      }
11      evidenceDueBy
12      evidenceSentOn
13      finalizedOn
14      id
15      initiatedAt
16      reasonDetails {
17        reason
18        networkReasonCode
19      }
20      status
21      type
22    }
23  }`,
24  {
25    variables: {
26      "id": "gid://shopify/ShopifyPaymentsDispute/598735659"
27    },
28  },
29);
30
31const data = await response.json();
32

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

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

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

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

const data = await response.json();

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

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

variables = {
  "id": "gid://shopify/ShopifyPaymentsDispute/598735659"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/ShopifyPaymentsDispute/598735659"
3}

Response

JSON

1{
2  "dispute": {
3    "amount": {
4      "amount": "11.5",
5      "currencyCode": "USD"
6    },
7    "evidenceDueBy": "2024-11-20T19:00:00-05:00",
8    "evidenceSentOn": null,
9    "finalizedOn": null,
10    "id": "gid://shopify/ShopifyPaymentsDispute/598735659",
11    "initiatedAt": "2013-05-04T00:00:00Z",
12    "reasonDetails": {
13      "reason": "FRAUDULENT",
14      "networkReasonCode": "4827"
15    },
16    "status": "NEEDS_RESPONSE",
17    "type": "CHARGEBACK"
18  }
19}