API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 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.

  • 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

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

Fields

Types that return ShopifyPaymentsDispute

Version unstable

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

Types that return ShopifyPaymentsDispute

Version 2021-04 (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.

  • 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-04 (Release candidate)

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

On this page

Fields

Version 2021-04 (Release candidate)

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

Types that return ShopifyPaymentsDisputeEdge

Version 2021-01 (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.

  • 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 (Latest)

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

On this page

Fields

Version 2021-01 (Latest)

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

Types that return ShopifyPaymentsDisputeEdge

Version 2020-10

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.

  • 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

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

On this page

Fields

Version 2020-10

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

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.

  • 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

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

On this page

Fields

Version 2020-07

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

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.

  • 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

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

On this page

Fields

Version 2020-04

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

Types that return ShopifyPaymentsDisputeEdge

Version 2020-01 (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.

  • 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 (Unsupported)

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

On this page

Fields

Version 2020-01 (Unsupported)

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

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.

  • 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)

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

On this page

Fields

Version 2019-10 (Unsupported)

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

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.

  • 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)

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

On this page

Fields

Version 2019-07 (Unsupported)

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

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.

  • 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)

An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.

On this page

Fields

Version 2019-04 (Unsupported)

An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.

Fields

Types that return ShopifyPaymentsDisputeEdge

Samples