dispute - admin-graphql - QUERY

Version: 2024-01

Description:

Returns dispute details based on ID.

Access Scopes

Arguments

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

Returns

• amount: MoneyV2! 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! A globally-unique ID.
• initiatedAt: DateTime! The date when this dispute was initiated.
• legacyResourceId: UnsignedInt64! 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! The reason of the dispute.
• status: DisputeStatus! The current state of the dispute.
• type: DisputeType! Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.

Examples

• Return a single dispute

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ShopifyPaymentsDisputesShow($id: ID!) { dispute(id: $id) { amount { amount currencyCode } evidenceDueBy evidenceSentOn finalizedOn id initiatedAt reasonDetails { reason networkReasonCode } status type } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ShopifyPaymentsDispute/598735659\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query ShopifyPaymentsDisputesShow($id: ID!) {\n      dispute(id: $id) {\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    \"variables\": {\n      \"id\": \"gid://shopify/ShopifyPaymentsDispute/598735659\"\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 ShopifyPaymentsDisputesShow($id: ID!) {\n    dispute(id: $id) {\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  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ShopifyPaymentsDispute/598735659\"\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 = <<<QUERY\n  query ShopifyPaymentsDisputesShow($id: ID!) {\n    dispute(id: $id) {\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  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/ShopifyPaymentsDispute/598735659\",\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 ShopifyPaymentsDisputesShow($id: ID!) {\n    dispute(id: $id) {\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/ShopifyPaymentsDispute/598735659\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ShopifyPaymentsDisputesShow($id: ID!) {\n  dispute(id: $id) {\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}"
        

  input: {
    "id": "gid://shopify/ShopifyPaymentsDispute/598735659"
  }

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