The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Dispute Evidence
Requires
shopify_payments_dispute_evidences access scope.Dispute evidence is submitted by the merchant to support the legitimacy of a dispute .
Was this section helpful?
#
Endpoints
- get/admin/api/latest/shopify_
payments/disputes/{dispute_ id}/dispute_ evidences. json Returns evidence associated with the dispute - put/admin/api/latest/shopify_
payments/disputes/{dispute_ id}/dispute_ evidences. json Updates dispute evidence
Anchor to
The Dispute Evidence resource
Anchor to
Properties
id
->
id
The ID of the dispute evidence.
payments_dispute_id
->
id
The ID of the dispute that the dispute evidence belongs to.
access_activity_log
The activity logs associated with the dispute evidence.
customer_email_address
The customer's email address.
customer_first_name
The customer's first name.
customer_last_name
The customer's last name.
uncategorized_text
The uncategorized text for the dispute evidence.
shipping_address
The mailing address for shipping that is provided by the customer.
cancellation_policy_disclosure
The cancellation policy disclosure associated with the dispute evidence.
cancellation_rebuttal
The cancellation rebuttal associated with the dispute evidence.
refund_policy_disclosure
The refund policy disclosure associated with the dispute evidence.
refund_refusal_explanation
The refund refusal explanation associated with the dispute evidence.
Was this section helpful?
{}
The Dispute Evidence resource
{
"id": 54534554564,
"payments_dispute_id": 54534554564,
"access_activity_log": "Test access activity logs",
"customer_email_address": "kermit@shopify.com",
"customer_first_name": "Kermit",
"customer_last_name": "The Frog",
"uncategorized_text": "Other compelling text for dispute",
"shipping_address": {
"address1": "1 Infinite Loop",
"address2": "Muppet Studio",
"city": "Cupertino",
"zip": "95014",
"country": "United States",
"country_code": "US",
"province": "California",
"province_code": "CA"
},
"cancellation_policy_disclosure": "Test cancellation policy disclosure",
"cancellation_rebuttal": "Test cancellation rebuttal",
"refund_policy_disclosure": "Test refund policy disclosure",
"refund_refusal_explanation": "Test refund refusal explanation",
"product_description": {
"Product name": "Draft",
"Title": "151cm",
"Price": "$10.00",
"Quantity": "1",
"Product Description": "good board"
},
"submitted": false,
"created_at": "2022-01-09T11:00:00-05:00",
"updated_on": "2022-01-09T11:00:00-05:00",
"dispute_evidence_files": {
"cancellation_policy_file_id": null,
"customer_communication_file_id": null,
"customer_signature_file_id": null,
"refund_policy_file_id": null,
"service_documentation_file_id": null,
"shipping_documentation_file_id": null,
"uncategorized_file_id": 1
},
"billing_address": {
"address1": "1 Infinite Loop",
"address2": "Muppet Studio",
"city": "Cupertino",
"zip": "95014",
"country": "United States",
"country_code": "US",
"province": "California",
"province_code": "CA"
},
"fulfillments": [
{
"shipping_carrier": "FedEx",
"shipping_tracking_number": 4321,
"shipping_date": "2017-01-02T13:00:00+00:00"
}
]
}
Anchor to GET request, Returns evidence associated with the disputegetReturns evidence associated with the dispute
get
Returns evidence associated with the dispute
Retrieves evidence associated with dispute ID.
api_version
string
required
dispute_id
string
required
Was this section helpful?
Retrieves dispute evidence by dispute ID
Retrieves dispute evidence by dispute ID
Path parameters
dispute_
string
required
Was this section helpful?
get
/admin/api/2025-07/shopify_
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/disputes/598735659/dispute_evidences.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{
"dispute_evidence": {
"id": 819974671,
"payments_dispute_id": 598735659,
"access_activity_log": null,
"billing_address": {
"id": 867402159,
"address1": "123 Amoebobacterieae St",
"address2": "",
"city": "Ottawa",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "K2P0V6"
},
"cancellation_policy_disclosure": null,
"cancellation_rebuttal": null,
"customer_email_address": "example@shopify.com",
"customer_first_name": "Kermit",
"customer_last_name": "the Frog",
"product_description": "Product name: Draft\nTitle: 151cm\nPrice: $10.00\nQuantity: 1\nProduct Description: good board",
"refund_policy_disclosure": null,
"refund_refusal_explanation": null,
"shipping_address": {
"id": 867402159,
"address1": "123 Amoebobacterieae St",
"address2": "",
"city": "Ottawa",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "K2P0V6"
},
"uncategorized_text": "Sample uncategorized text",
"created_at": "2025-07-01T14:28:21-04:00",
"updated_at": "2025-07-01T14:31:37-04:00",
"submitted_by_merchant_on": null,
"fulfillments": [
{
"shipping_carrier": "UPS",
"shipping_tracking_number": "1234",
"shipping_date": "2017-01-01"
},
{
"shipping_carrier": "FedEx",
"shipping_tracking_number": "4321",
"shipping_date": "2017-01-02"
}
],
"dispute_evidence_files": {
"cancellation_policy_file_id": null,
"customer_communication_file_id": 539650252,
"customer_signature_file_id": 799719586,
"refund_policy_file_id": null,
"service_documentation_file_id": null,
"shipping_documentation_file_id": 799719586,
"uncategorized_file_id": 567271523
}
}
}
examples
Retrieves dispute evidence by dispute ID
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/disputes/598735659/dispute_evidences.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.DisputeEvidence.find({ session: session, dispute_id: 598735659, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::DisputeEvidence.find( session: test_session, dispute_id: 598735659, )// Session is built by the OAuth process await shopify.rest.DisputeEvidence.find({ session: session, dispute_id: 598735659, });response
HTTP/1.1 200 OK{"dispute_evidence":{"id":819974671,"payments_dispute_id":598735659,"access_activity_log":null,"billing_address":{"id":867402159,"address1":"123 Amoebobacterieae St","address2":"","city":"Ottawa","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","zip":"K2P0V6"},"cancellation_policy_disclosure":null,"cancellation_rebuttal":null,"customer_email_address":"example@shopify.com","customer_first_name":"Kermit","customer_last_name":"the Frog","product_description":"Product name: Draft\nTitle: 151cm\nPrice: $10.00\nQuantity: 1\nProduct Description: good board","refund_policy_disclosure":null,"refund_refusal_explanation":null,"shipping_address":{"id":867402159,"address1":"123 Amoebobacterieae St","address2":"","city":"Ottawa","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","zip":"K2P0V6"},"uncategorized_text":"Sample uncategorized text","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:31:37-04:00","submitted_by_merchant_on":null,"fulfillments":[{"shipping_carrier":"UPS","shipping_tracking_number":"1234","shipping_date":"2017-01-01"},{"shipping_carrier":"FedEx","shipping_tracking_number":"4321","shipping_date":"2017-01-02"}],"dispute_evidence_files":{"cancellation_policy_file_id":null,"customer_communication_file_id":539650252,"customer_signature_file_id":799719586,"refund_policy_file_id":null,"service_documentation_file_id":null,"shipping_documentation_file_id":799719586,"uncategorized_file_id":567271523}}}
Anchor to PUT request, Updates dispute evidenceputUpdates dispute evidence
put
Updates dispute evidence
Updates dispute evidence associated with the dispute ID.
api_version
string
required
dispute_id
string
required
Was this section helpful?
Submits dispute evidence request
Submits dispute evidence request
Path parameters
dispute_
string
required
Update dispute evidence's information
Update dispute evidence's information
Path parameters
dispute_
string
required
Request body
dispute_
Dispute_evidence resource
Show dispute_evidence properties
Show dispute_evidence properties
dispute_
The activity logs associated with the dispute evidence.
dispute_
The cancellation policy disclosure associated with the dispute evidence.
dispute_
The cancellation rebuttal associated with the dispute evidence.
dispute_
The customer's email address.
dispute_
The customer's first name.
dispute_
The customer's last name.
dispute_
The refund policy disclosure associated with the dispute evidence.
dispute_
The refund refusal explanation associated with the dispute evidence.
dispute_
The uncategorized text for the dispute evidence.
Was this section helpful?
put
/admin/api/2025-07/shopify_
curl -d '{"dispute_evidence":{"submit_evidence":true}}' \
-X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/disputes/598735659/dispute_evidences.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}
Response
JSON
HTTP/1.1 200 OK
{
"dispute_evidence": {
"id": 819974671,
"payments_dispute_id": 598735659,
"access_activity_log": null,
"billing_address": {
"id": 867402159,
"address1": "123 Amoebobacterieae St",
"address2": "",
"city": "Ottawa",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "K2P0V6"
},
"cancellation_policy_disclosure": null,
"cancellation_rebuttal": null,
"customer_email_address": "example@shopify.com",
"customer_first_name": "Kermit",
"customer_last_name": "the Frog",
"product_description": "Product name: Draft\nTitle: 151cm\nPrice: $10.00\nQuantity: 1\nProduct Description: good board",
"refund_policy_disclosure": null,
"refund_refusal_explanation": null,
"shipping_address": {
"id": 867402159,
"address1": "123 Amoebobacterieae St",
"address2": "",
"city": "Ottawa",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "K2P0V6"
},
"uncategorized_text": "Sample uncategorized text",
"created_at": "2025-07-01T14:28:21-04:00",
"updated_at": "2025-07-01T14:31:37-04:00",
"submitted_by_merchant_on": "2025-07-01T14:31:37-04:00",
"fulfillments": [
{
"shipping_carrier": "UPS",
"shipping_tracking_number": "1234",
"shipping_date": "2017-01-01"
},
{
"shipping_carrier": "FedEx",
"shipping_tracking_number": "4321",
"shipping_date": "2017-01-02"
}
],
"dispute_evidence_files": {
"cancellation_policy_file_id": null,
"customer_communication_file_id": 539650252,
"customer_signature_file_id": 799719586,
"refund_policy_file_id": null,
"service_documentation_file_id": null,
"shipping_documentation_file_id": 799719586,
"uncategorized_file_id": 567271523
}
}
}
examples
Submits dispute evidence request
curl -d '{"dispute_evidence":{"submit_evidence":true}}' \ -X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/disputes/598735659/dispute_evidences.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const dispute_evidence = new admin.rest.resources.DisputeEvidence({session: session}); dispute_evidence.dispute_id = 598735659; dispute_evidence.submit_evidence = true; await dispute_evidence.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session dispute_evidence = ShopifyAPI::DisputeEvidence.new(session: test_session) dispute_evidence.dispute_id = 598735659 dispute_evidence.submit_evidence = true dispute_evidence.save!// Session is built by the OAuth process const dispute_evidence = new shopify.rest.DisputeEvidence({session: session}); dispute_evidence.dispute_id = 598735659; dispute_evidence.submit_evidence = true; await dispute_evidence.save({ update: true, });response
HTTP/1.1 200 OK{"dispute_evidence":{"id":819974671,"payments_dispute_id":598735659,"access_activity_log":null,"billing_address":{"id":867402159,"address1":"123 Amoebobacterieae St","address2":"","city":"Ottawa","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","zip":"K2P0V6"},"cancellation_policy_disclosure":null,"cancellation_rebuttal":null,"customer_email_address":"example@shopify.com","customer_first_name":"Kermit","customer_last_name":"the Frog","product_description":"Product name: Draft\nTitle: 151cm\nPrice: $10.00\nQuantity: 1\nProduct Description: good board","refund_policy_disclosure":null,"refund_refusal_explanation":null,"shipping_address":{"id":867402159,"address1":"123 Amoebobacterieae St","address2":"","city":"Ottawa","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","zip":"K2P0V6"},"uncategorized_text":"Sample uncategorized text","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:31:37-04:00","submitted_by_merchant_on":"2025-07-01T14:31:37-04:00","fulfillments":[{"shipping_carrier":"UPS","shipping_tracking_number":"1234","shipping_date":"2017-01-01"},{"shipping_carrier":"FedEx","shipping_tracking_number":"4321","shipping_date":"2017-01-02"}],"dispute_evidence_files":{"cancellation_policy_file_id":null,"customer_communication_file_id":539650252,"customer_signature_file_id":799719586,"refund_policy_file_id":null,"service_documentation_file_id":null,"shipping_documentation_file_id":799719586,"uncategorized_file_id":567271523}}}Update dispute evidence's information
curl -d '{"dispute_evidence":{"access_activity_log":"https://example.com/access-activity-log","cancellation_policy_disclosure":"https://example.com/cancellation-policy","cancellation_rebuttal":"https://example.com/cancellation-rebuttal","customer_email_address":"customer@example.com","customer_first_name":"John","customer_last_name":"Doe","refund_policy_disclosure":"https://example.com/refund-policy","refund_refusal_explanation":"Product must have receipt of proof of purchase","uncategorized_text":"Any additional notes","shipping_address_attributes":{"address1":"1 Infinite Loop","address2":"Muppet Studio","city":"Cupertino","zip":"95014","country_code":"US","province_code":"CA"},"fulfillments_attributes":[{"shipping_carrier":"FedEx","shipping_tracking_number":4321,"shipping_date":"2017-01-02T13:00:00+00:00"}]}}' \ -X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/disputes/598735659/dispute_evidences.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const dispute_evidence = new admin.rest.resources.DisputeEvidence({session: session}); dispute_evidence.dispute_id = 598735659; dispute_evidence.access_activity_log = "https://example.com/access-activity-log"; dispute_evidence.cancellation_policy_disclosure = "https://example.com/cancellation-policy"; dispute_evidence.cancellation_rebuttal = "https://example.com/cancellation-rebuttal"; dispute_evidence.customer_email_address = "customer@example.com"; dispute_evidence.customer_first_name = "John"; dispute_evidence.customer_last_name = "Doe"; dispute_evidence.refund_policy_disclosure = "https://example.com/refund-policy"; dispute_evidence.refund_refusal_explanation = "Product must have receipt of proof of purchase"; dispute_evidence.uncategorized_text = "Any additional notes"; dispute_evidence.shipping_address_attributes = { "address1": "1 Infinite Loop", "address2": "Muppet Studio", "city": "Cupertino", "zip": "95014", "country_code": "US", "province_code": "CA" }; dispute_evidence.fulfillments_attributes = [ { "shipping_carrier": "FedEx", "shipping_tracking_number": 4321, "shipping_date": "2017-01-02T13:00:00+00:00" } ]; await dispute_evidence.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session dispute_evidence = ShopifyAPI::DisputeEvidence.new(session: test_session) dispute_evidence.dispute_id = 598735659 dispute_evidence.access_activity_log = "https://example.com/access-activity-log" dispute_evidence.cancellation_policy_disclosure = "https://example.com/cancellation-policy" dispute_evidence.cancellation_rebuttal = "https://example.com/cancellation-rebuttal" dispute_evidence.customer_email_address = "customer@example.com" dispute_evidence.customer_first_name = "John" dispute_evidence.customer_last_name = "Doe" dispute_evidence.refund_policy_disclosure = "https://example.com/refund-policy" dispute_evidence.refund_refusal_explanation = "Product must have receipt of proof of purchase" dispute_evidence.uncategorized_text = "Any additional notes" dispute_evidence.shipping_address_attributes = { "address1" => "1 Infinite Loop", "address2" => "Muppet Studio", "city" => "Cupertino", "zip" => "95014", "country_code" => "US", "province_code" => "CA" } dispute_evidence.fulfillments_attributes = [ { "shipping_carrier" => "FedEx", "shipping_tracking_number" => 4321, "shipping_date" => "2017-01-02T13:00:00+00:00" } ] dispute_evidence.save!// Session is built by the OAuth process const dispute_evidence = new shopify.rest.DisputeEvidence({session: session}); dispute_evidence.dispute_id = 598735659; dispute_evidence.access_activity_log = "https://example.com/access-activity-log"; dispute_evidence.cancellation_policy_disclosure = "https://example.com/cancellation-policy"; dispute_evidence.cancellation_rebuttal = "https://example.com/cancellation-rebuttal"; dispute_evidence.customer_email_address = "customer@example.com"; dispute_evidence.customer_first_name = "John"; dispute_evidence.customer_last_name = "Doe"; dispute_evidence.refund_policy_disclosure = "https://example.com/refund-policy"; dispute_evidence.refund_refusal_explanation = "Product must have receipt of proof of purchase"; dispute_evidence.uncategorized_text = "Any additional notes"; dispute_evidence.shipping_address_attributes = { "address1": "1 Infinite Loop", "address2": "Muppet Studio", "city": "Cupertino", "zip": "95014", "country_code": "US", "province_code": "CA" }; dispute_evidence.fulfillments_attributes = [ { "shipping_carrier": "FedEx", "shipping_tracking_number": 4321, "shipping_date": "2017-01-02T13:00:00+00:00" } ]; await dispute_evidence.save({ update: true, });response
HTTP/1.1 200 OK{"dispute_evidence":{"id":819974671,"payments_dispute_id":598735659,"access_activity_log":"https://example.com/access-activity-log","billing_address":{"id":867402159,"address1":"1 Infinite Loop","address2":"Muppet Studio","city":"Cupertino","province":"California","province_code":"CA","country":"United States","country_code":"US","zip":"95014"},"cancellation_policy_disclosure":"https://example.com/cancellation-policy","cancellation_rebuttal":"https://example.com/cancellation-rebuttal","customer_email_address":"customer@example.com","customer_first_name":"John","customer_last_name":"Doe","product_description":"Product name: Draft\nTitle: 151cm\nPrice: $10.00\nQuantity: 1\nProduct Description: good board","refund_policy_disclosure":"https://example.com/refund-policy","refund_refusal_explanation":"Product must have receipt of proof of purchase","shipping_address":{"id":867402159,"address1":"1 Infinite Loop","address2":"Muppet Studio","city":"Cupertino","province":"California","province_code":"CA","country":"United States","country_code":"US","zip":"95014"},"uncategorized_text":"Any additional notes","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:31:40-04:00","submitted_by_merchant_on":null,"fulfillments":[{"shipping_carrier":"UPS","shipping_tracking_number":"1234","shipping_date":"2017-01-01"},{"shipping_carrier":"FedEx","shipping_tracking_number":"4321","shipping_date":"2017-01-02"},{"shipping_carrier":"FedEx","shipping_tracking_number":"4321","shipping_date":"2017-01-02"}],"dispute_evidence_files":{"cancellation_policy_file_id":null,"customer_communication_file_id":539650252,"customer_signature_file_id":799719586,"refund_policy_file_id":null,"service_documentation_file_id":null,"shipping_documentation_file_id":799719586,"uncategorized_file_id":567271523}}}