The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Requires ANY of the following access scopes:
shopify_payments_payouts
, shopify_payments
.
Disputes occur when a buyer questions the legitimacy of a charge with their financial institution.
Was this section helpful?
Properties
id
->id
The ID of the dispute.
order_id
->id
The ID of the order that the dispute belongs to.
type
->type
Whether the dispute is still in the inquiry phase or has turned into a chargeback.
Valid values:
currency
The ISO 4217 currency code of the dispute amount.
amount
->amount
The total amount disputed by the cardholder.
The reason for the dispute provided by the cardholder's bank.
evidence_due_by
The deadline for evidence submission.
evidence_sent_on
"The date and time (ISO 8601 format) when
evidence was sent. Returns
null
if evidence has not yet been sent.finalized_on
The date and time (ISO 8601 format) when
this dispute was resolved. Returns
null
if the dispute is not yet resolved.Was this section helpful?
Retrieve all disputes ordered by
initiated_at
date and time (ISO 8601 format), with the most recent being first.
Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.api_version
string
required
initiated_at
Return only disputes with the specified
initiated_at
date (ISO 8601 format).last_id
Return only disputes before the specified ID.
since_id
Return only disputes after the specified ID.
status
Return only disputes with the specified status.
Was this section helpful?
Was this section helpful?
Retrieves a single dispute by ID.
api_version
string
required
dispute_id
string
required
Was this section helpful?
Path parameters
string
required
Was this section helpful?