Skip to main content

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 File Upload

Requires shopify_payments_dispute_file_uploads access scope.

Upload and manage dispute evidence files for a dispute

Was this section helpful?
#

Endpoints

Anchor to

The Dispute File Upload resource

Anchor to

Properties

id
->
id

The unique identifier of the dispute file upload.

shop_id

The unique identifier of the shop

file_size
->
fileSize

Size of the uploaded file in bytes

file_type
->
fileType

Mime file type of uploaded file

original_filename
->
originalFileName

Uploaded file's original name when it was first submitted

filename

Uploaded file's new name in Shopify's system

dispute_evidence_id

Unique identifier for the dispute evidence this file belongs to

dispute_evidence_type
->
disputeEvidenceType

Type of evidence this file represents. It can be one of the following:

Show dispute_evidence_type properties
  • customer_signature_file
  • customer_communication_file
  • refund_policy_file
  • cancellation_policy_file
  • uncategorized_file
  • shipping_documentation_file
  • service_documentation_file
url
->
url

URL to uploaded file

Was this section helpful?
{}

The Dispute File Upload resource

{
"id": 54534554564,
"shop_id": 54534554564,
"file_size": 1231,
"file_type": "application/pdf",
"original_filename": "original.pdf",
"filename": "5bfd2770-7df8-47ac-a78a-00ffa867aafc.pdf",
"dispute_evidence_id": 2314551,
"dispute_evidence_type": "uncategorized_file",
"url": "https://cdn.shopify.com/disputes/5bfd2770-7df8-47ac-a78a-00ffa867aafc.pdf"
}

Anchor to POST request, Upload a file to a dispute
post
Upload a file to a dispute

disputeEvidenceUpdate

Upload a .png, .jpeg, or .pdf file of a category to a dispute. Maximum total files size of all files should be less than 4 MBs

Anchor to Parameters of Upload a file to a disputeParameters

api_version
string
required
dispute_id
string
required
Was this section helpful?

Anchor to post-shopify-payments-disputes-dispute-id-dispute-file-uploads-examplesExamples

Uploads a dispute evidence file

Path parameters
dispute_id=598735659
string
required
Request body
dispute_file_upload
Dispute_file_upload resource
Show dispute_file_upload properties
dispute_file_upload.filename:"test.pdf"

Uploaded file's new name in Shopify's system

Was this section helpful?
post

/admin/api/2025-07/shopify_payments/disputes/598735659/dispute_file_uploads.json

curl -d '{"dispute_file_upload":{"document_type":"uncategorized_file","filename":"test.pdf","mimetype":"application/pdf","data":"JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPDwgL0xlbmd0aCA1IDAgUiAvRmlsdGVyIC9GbGF0ZURlY29kZSA+PgpzdHJlYW0KeAG1nFtvHMd2hd/nV0zeKEBnztxJIk+OfQ6QIBZkWHEegjxQFC3pgCJpUzTy8/OtWquqq+dCjmJEAnq6q/Z979pVtaubv01/mv42veT/5nI9PT9fT3+/mf7n9G761+8fF9Prx+m8/H+8Bmo+W679rJuLy9nF+eXFxfR8MZ/N15PrL9N/eQfMfDHfTN9dT9ebApufd1+mf333bjFdTN/9Ov2v6dm/3//+arqent18eTX9y2Z6NuVnezE9+/xqup2cPTy+AvLsaafzw/0t3dOz4FYcAwtzeva1XGvP1ZdXE1G/cfPrUed14XF/Z/QbPxow8E+WsVH78PnVBB4PZmU8o7nl7mMFvbGgvUyzEfMfEGyFJnfh2xCf6l2Y313Vhhjjynx9vRLVSbPed1hxibp3N1d3oP339N2/Tf/2rrj4iPO2l+ez1XLanDdfryYvOu/zB3nLTlvKa1jtL/jr853bsYmsDthEYE9uTWdgpVXBvf380f0Bu73yI84SzQZ3ZWKh3ZpllQU6ByvUq0BYqUZXmL0X9cnZjX6mZzhYBrv3E8YcsfxRz0N3gAsFtIsIk7MqQqjchnZ4V1HS2gQ/AGVHFkH/sESfgx3tdmlUW8UosWBh3NF6MK1P/gmpKBOKYZPGgDQFf5Udmomrd28/R8P6O5jvlMC7WM8u+qyxOiFrfI+GjBrEPC/icI83uDIwL0sYcu1hpMIKWDSgx3gMSu6JRvAIvYKtFoZsuYoSFqC9YmNAnnAvV9PAXntQmJJ+0zUPZR/Ch0gGuBIzmIWsbRiSXGimvUhm46tVNGTF65nZEDi5E9zCus3iG+P61QR+lmFM8beC7x4r4f7ZSIc3FlWBv3SgyciGJzd0EhDHyvKdafp7k3lWv+OhtD6/nC3nm8V0W0LpW3MYeik13KJZHfRrlHjDI97CAsoPd7tJ57g4bT7cni9nZI2WUg/Nh5Pd+bBk+eWCXMoko4ns451/EZOh56tbZPXMmCCQyv6ngBBloCkyCpmbjzdGwrq0Z9Zo3fgFsjefTJIhzdPTbZneBlEiwvtP2Kin/VZMwGbE0OzrzZ0ZhetvTzdTRb80ymzaeJtbm3h/e7oyagNgtEJ3NIc+vpog4Y4c8hWxxizfW6SMduE/fbR2A/l4b6I1z7EJcXM5W3fO21zO+Xd0QYNUXtB8IZbxCposEDQ/8Nf8gSOILKm3IFyVIoAkwhR+hig/E2WAeLYAjkg2dFNzH8kChLDpeU9qo6ExnMRqNLAccu2LUJIQFL80yD9KTIw5mDcDuRfWWgWQZEQfiaeHMCmjGbq/Hyk7MtzrHeGJn/OJ0jHEoYOryTncB+kLVGkzh9gETWkatIrZxX9yJnrNZbbJjscsp41t6qE7Fm2i2QhBQh2NmhwjCYOMjU9JJ+vtbHvxjcvr+2SR+1mRQd5cL5LdVhONdInmaz98ClByg3sb6g2TiSYphAc1zYSsR3MDC023PmHHhF2h7IFtQnhL1skYdeoJciNm9PsPV+5IbtnR6UeP/mwK3nuN3kg8RFcrFaZXFqEBWadRPiuie24rot/g/ePeWl8sZhfb5cV0W7zV5Y8Dm6G95N8lyMKrN5BNMBjyuAzDBLRaz5ZDwMwvV0fTF95x+rrW4tW5ST9a4PODuQhnLWOIHQK/g8BkXkKoTQkYiNelTVY9Bw2Lqy9oeJA2zQnqY2io7/qa4dYReEw7Y1etlZJxQyiC7lAKnWuLFRjsyPRAuCBppaVoQdQwCs3rG+SCYfim87Hi5PkZHhWyMJ6MzdcEtlls0x0N8+i+R/+Y5qTaMWRsi4hibbW+R/hI6bYqUBxZ+thXG9L0yVVCC6nHZqZTImy5
-X POST "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/disputes/598735659/dispute_file_uploads.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

{}

Response

JSON
HTTP/1.1 200 OK
{
"dispute_file_upload": {
"id": 1047018778,
"shop_id": 220006451,
"file_size": 34509,
"file_type": "application/pdf",
"original_filename": "test.pdf",
"filename": "6d1c4db6-9b6e-47e2-8374-89e0e2ddb7e4.pdf",
"created_at": "2025-07-01T14:42:22-04:00",
"updated_at": "2025-07-01T14:42:22-04:00",
"dispute_evidence_id": 819974671,
"dispute_evidence_type": "uncategorized_file",
"url": "https://unittest.storage.googleapis.com/s/files/1/0002/2000/6451/payments_file_uploads/6d1c4db6-9b6e-47e2-8374-89e0e2ddb7e4.pdf?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=shopify-core-gcs-test%40shopify-tiers.iam.gserviceaccount.com%2F20200912%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=2025-07-01T18:42:22Z&X-Goog-Expires=604800&X-Goog-SignedHeaders=host&response-content-disposition=&X-Goog-Signature=87811646776a232917997f6a4595871d9123629da45d35b2b915e7210eececff55a58147e79ac636861617cc21b5a2f\n 6e5ea6547d9a20e9503e64caca84c9043ecccbf27d20142118017c60d2418edb7896c53eb466335fca\n 9153d8d73c15645962eace819a3588301d55bcbc5b4ecf2225561de914b104e2069daa400e741a59a\n 306d094f7b147c0ae2215f8203e4ce20a907c983a2e4be074c584725bd1c9e399f633499531160dac25\n b34054527795ef5ea48a4ac1d392585d4bc0976d62cab57e18d33547c9110599f39368983e4c88275790\n 0bac1eddcb41b87d4d26269bfe01b0161ef0a81088a0e4d6596380f4d3d37e4e72a8c5fefc6bc07551efb59"
}
}

Anchor to DELETE request, Delete a dispute evidence file
del
Delete a dispute evidence file

disputeEvidenceUpdate

Delete a dispute evidence file given an ID.

Anchor to Parameters of Delete a dispute evidence fileParameters

api_version
string
required
dispute_file_upload_id
string
required
dispute_id
string
required
Was this section helpful?

Anchor to delete-shopify-payments-disputes-dispute-id-dispute-file-uploads-dispute-file-upload-id-examplesExamples

Delete a dispute evidence file from a dispute

Was this section helpful?
del

/admin/api/2025-07/shopify_payments/disputes/598735659/dispute_file_uploads/799719586.json

curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/disputes/598735659/dispute_file_uploads/799719586.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK