API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

ShopifyPaymentsDispute object

Version unstable

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

Required access

read_orders access scope.

Fields

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 has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

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 is 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.

Types that return ShopifyPaymentsDispute

Implements

Version unstable

Fields

edges ([ShopifyPaymentsDisputeEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Types that return ShopifyPaymentsDispute

Version unstable

Fields

cursor (String!)

A cursor for use in pagination.

node (ShopifyPaymentsDispute!)

The item at the end of ShopifyPaymentsDisputeEdge.

Types that return ShopifyPaymentsDispute

Version 2021-01 (Release candidate)

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

Required access

read_orders access scope.

Fields

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 has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

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 is 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.

Types that return ShopifyPaymentsDispute

Implements

Version 2021-01 (Release candidate)

On this page

Fields

edges ([ShopifyPaymentsDisputeEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.

node (ShopifyPaymentsDispute!)

The item at the end of ShopifyPaymentsDisputeEdge.

Types that return ShopifyPaymentsDisputeEdge

Version 2020-10 (Latest)

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

Required access

read_orders access scope.

Fields

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 has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

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 is 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.

Types that return ShopifyPaymentsDispute

Implements

Version 2020-10 (Latest)

On this page

Fields

edges ([ShopifyPaymentsDisputeEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-10 (Latest)

Fields

cursor (String!)

A cursor for use in pagination.

node (ShopifyPaymentsDispute!)

The item at the end of ShopifyPaymentsDisputeEdge.

Types that return ShopifyPaymentsDisputeEdge

Version 2020-07

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

Required access

read_orders access scope.

Fields

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 has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

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 is 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.

Types that return ShopifyPaymentsDispute

Implements

Version 2020-07

On this page

Fields

edges ([ShopifyPaymentsDisputeEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-07

Fields

cursor (String!)

A cursor for use in pagination.

node (ShopifyPaymentsDispute!)

The item at the end of ShopifyPaymentsDisputeEdge.

Types that return ShopifyPaymentsDisputeEdge

Version 2020-04

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

Required access

read_orders access scope.

Fields

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 has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

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 is 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.

Types that return ShopifyPaymentsDispute

Implements

Version 2020-04

On this page

Fields

edges ([ShopifyPaymentsDisputeEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-04

Fields

cursor (String!)

A cursor for use in pagination.

node (ShopifyPaymentsDispute!)

The item at the end of ShopifyPaymentsDisputeEdge.

Types that return ShopifyPaymentsDisputeEdge

Version 2020-01

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

Required access

read_orders access scope.

Fields

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 has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

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 is 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.

Types that return ShopifyPaymentsDispute

Implements

Version 2020-01

On this page

Fields

edges ([ShopifyPaymentsDisputeEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-01

Fields

cursor (String!)

A cursor for use in pagination.

node (ShopifyPaymentsDispute!)

The item at the end of ShopifyPaymentsDisputeEdge.

Types that return ShopifyPaymentsDisputeEdge

Version 2019-10 (Unsupported)

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

Required access

read_orders access scope.

Fields

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 has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

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 is 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.

Types that return ShopifyPaymentsDispute

Implements

Version 2019-10 (Unsupported)

On this page

Fields

edges ([ShopifyPaymentsDisputeEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-10 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (ShopifyPaymentsDispute!)

The item at the end of ShopifyPaymentsDisputeEdge.

Types that return ShopifyPaymentsDisputeEdge

Version 2019-07 (Unsupported)

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

Required access

read_orders access scope.

Fields

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 has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

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 is 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.

Types that return ShopifyPaymentsDispute

Implements

Version 2019-07 (Unsupported)

On this page

Fields

edges ([ShopifyPaymentsDisputeEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-07 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (ShopifyPaymentsDispute!)

The item at the end of ShopifyPaymentsDisputeEdge.

Types that return ShopifyPaymentsDisputeEdge

Version 2019-04 (Unsupported)

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

Required access

read_orders access scope.

Fields

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 has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

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 is 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.

Types that return ShopifyPaymentsDispute

Implements

Version 2019-04 (Unsupported)

On this page

Fields

edges ([ShopifyPaymentsDisputeEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-04 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (ShopifyPaymentsDispute!)

The item at the end of ShopifyPaymentsDisputeEdge.

Types that return ShopifyPaymentsDisputeEdge

Samples