Skip to main content
Anchor to ShopifyPaymentsDispute

ShopifyPaymentsDispute

object

Requires User must have read_shopify_payments_disputes access.

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

Anchor to FieldsFields

Anchor to amountamount
•MoneyV2!
non-null

The total amount disputed by the cardholder.

Anchor to disputeEvidencedisputeEvidence
•ShopifyPaymentsDisputeEvidence!
non-null

The evidence associated with the dispute.

Anchor to evidenceDueByevidenceDueBy
•DateTime

The deadline for evidence submission.

Anchor to evidenceSentOnevidenceSentOn
•DateTime

The date when evidence was sent. Returns null if evidence hasn't yet been sent.

Anchor to finalizedOnfinalizedOn
•DateTime

The date when this dispute was resolved. Returns null if the dispute isn't yet resolved.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to initiatedAtinitiatedAt
•DateTime!
non-null

The date when this dispute was initiated.

Anchor to legacyResourceIdlegacyResourceId
•UnsignedInt64!
non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to orderorder
•Order

The order that contains the charge that's under dispute.

Anchor to reasonDetailsreasonDetails
•ShopifyPaymentsDisputeReasonDetails!
non-null

The reason of the dispute.

Anchor to statusstatus
•DisputeStatus!
non-null

The current state of the dispute.

Anchor to typetype
•DisputeType!
non-null

Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.

Was this section helpful?

Anchor to QueriesQueries

Anchor to disputedispute
•query

Returns a ShopifyPaymentsDispute resource by ID.

Arguments

Anchor to idid
•ID!
required

The ID of the ShopifyPaymentsDispute to return.

Anchor to disputesdisputes
•query

All disputes related to the Shop.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to initiated_at
•time
Anchor to status
•string
Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?