Choose a version:

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

ShopifyPaymentsDispute

•

ShopifyPaymentsDispute

A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.

amount• MoneyV2! non-null: The total amount disputed by the cardholder.
evidenceDueBy• Date: The deadline for evidence submission.
evidenceSentOn• Date: The date when evidence was sent. Returns null if evidence hasn't yet been sent.
finalizedOn• Date: The date when this dispute was resolved. Returns null if the dispute isn't yet resolved.
id• ID! non-null: A globally-unique ID.
initiatedAt• DateTime! non-null: The date when this dispute was initiated.
legacyResourceId• UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
order• Order: The order that contains the charge that's under dispute.
reasonDetails• ShopifyPaymentsDisputeReasonDetails! non-null: The reason of the dispute.
status• DisputeStatus! non-null: The current state of the dispute.
type• DisputeType! non-null: Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.

Was this section helpful?

Return a single dispute

Open in GraphiQL

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

initiatedAt

reasonDetails {

reason

networkReasonCode

}

status

type

}

}`,

{

variables: {

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

);

const data = await response.json();

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/2024-10/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

{

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

}

Response

JSON

{

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

}