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.

Anchor to section titled 'undefined'

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?
Anchor to section titled 'The Dispute Evidence resource'

The Dispute Evidence resource

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
->accessActivityLog
The activity logs associated with the dispute evidence.
customer_email_address
->customerEmailAddress
The customer's email address.
customer_first_name
->customerFirstName
The customer's first name.
customer_last_name
->customerLastName
The customer's last name.
uncategorized_text
->uncategorizedText
The uncategorized text for the dispute evidence.
shipping_address
->shippingAddress
The mailing address for shipping that is provided by the customer.
cancellation_policy_disclosure
->cancellationPolicyDisclosure
The cancellation policy disclosure associated with the dispute evidence.
cancellation_rebuttal
->cancellationRebuttal
The cancellation rebuttal associated with the dispute evidence.
refund_policy_disclosure
->refundPolicyDisclosure
The refund policy disclosure associated with the dispute evidence.
refund_refusal_explanation
->refundRefusalExplanation
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 section titled 'GET request, Returns evidence associated with the dispute'

get
Returns evidence associated with the dispute

disputeEvidence
Retrieves evidence associated with dispute ID.
Anchor to section titled 'Parameters of Returns evidence associated with the dispute'

Parameters

api_version
string
required
dispute_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Returns evidence associated with the dispute'

Examples

Path parameters
disputeid=598735659
string
required
Was this section helpful?
get
/admin/api/2024-10/shopify_payments/disputes/598735659/dispute_evidences.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/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": "2024-09-19T10:50:00-04:00",
    "updated_at": "2024-09-19T10:50:36-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 section titled 'PUT request, Updates dispute evidence'

put
Updates dispute evidence

disputeEvidenceUpdate
Updates dispute evidence associated with the dispute ID.
Anchor to section titled 'Parameters of Updates dispute evidence'

Parameters

api_version
string
required
dispute_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Updates dispute evidence'

Examples

Path parameters
disputeid=598735659
string
required
Was this section helpful?
put
/admin/api/2024-10/shopify_payments/disputes/598735659/dispute_evidences.json
Copy
curl -d '{"dispute_evidence":{"submit_evidence":true}}' \
-X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/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": "2024-09-19T10:50:00-04:00",
    "updated_at": "2024-09-19T10:50:40-04:00",
    "submitted_by_merchant_on": "2024-09-19T10:50:40-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
    }
  }
}