riverty logo

Docs

Path

GET /{clientId}/disputes

Request Parameters

clientId
required
integer
unique identifier for the client
sortBy
string
(optional) sort results by a property. By default, CreatedAt.
sortMethod
string
(optional) select the sorting method to be asc or desc. By default, desc.
query
string
(optional) query is a key to search for a dispute by invoice number or ticket number.
status
integer
(optional) status is status of dispute.
startDate
string
(optional) startDate is the earliest creation time of the dispute to be considered.
endDate
string
(optional) endDate is the latest creation time of the dispute to be considered.
pageSize
integer
(optional) number of items per page. Default is 20.
pageNumber
integer
(optional) jump to a page. Default is 1

Responses

Successful Request

Request Example

    
        null

Response Example

    
        [
 {
  "id": "b87a9941-5d89-46a7-8890-3d1beec40def",
  "customerId": "e5477d6d-eb90-4dd8-a823-2fc664541859",
  "clientId": 1,
  "source": "Web",
  "reason": {
   "id": 10203,
   "name": "I have a problem with the product"
  },
  "description": "Last week, I bought new TV from ABC, Frankfurt branch, while when I I recieved it today, I found TV's screen is broken.",
  "invoiceId": "INV#1234",
  "invoiceDate": "12/05/2023 15:49:32",
  "amount": "600.54",
  "disputeAmount": "600.54",
  "orderId": "987212",
  "orderNumber": "OR#123987445",
  "trackingId": "RT12409821212",
  "attachments": [
   {
    "id": "2c442aee-509f-4622-a53c-9f7b3df04342",
    "fileName": "0b5d53af-0af9-4e55-8e4d-3f3f70ec0128",
    "originalFileName": "tv_screen_broken.jpg",
    "createdAt": "12/05/2023 15:49:32",
    "size": 12432,
    "source": "Customer",
    "mimeType": "image/jpg",
    "url": "/Complaints/b87a9941-5d89-46a7-8890-3d1beec40def/attachments/2c442aee-509f-4622-a53c-9f7b3df04342"
   }
  ],
  "complaintStatus": {
   "id": 1,
   "name": "Waiting for shop"
  },
  "createdAt": "2023-12-12T15:49:32.4086007Z",
  "updatedAt": "2023-12-12T15:49:32.4086203Z",
  "customer": {
   "customerId": "06071fcd-78bd-4114-9ee1-7e4113c7c35b",
   "firstName": "Martin",
   "lastName": "John",
   "countryCode": "DE",
   "email": "martin.john@gmail.com",
   "name": "Martin John"
  },
  "client": {
   "id": 1,
   "name": "ABC",
   "email": "info@abc.de",
   "countryCode": "DE",
   "country": "Germany"
  }
 },
 {
  "id": "b87a9941-5d89-46a7-8890-3d1beec40def",
  "customerId": "9aee8e2a-8c5d-41cd-98d1-79861b072402",
  "clientId": 4,
  "source": "Web",
  "reason": {
   "id": 10203,
   "name": "I didn't order the product/ fraud"
  },
  "description": "Hello, Today I checked my account and I found a new order for mobile device at 13:14 and I am sure I did not order it. I think this is fraud who submitted the order on-behalf of me",
  "invoiceId": "INV#1114",
  "invoiceDate": "12/05/2023 15:49:32",
  "amount": "14.55",
  "disputeAmount": "14.55",
  "orderId": "121492",
  "orderNumber": "OR#123987466",
  "trackingId": "RT12409821212",
  "attachments": [],
  "complaintStatus": {
   "id": 4,
   "name": "Resolved"
  },
  "createdAt": "2023-12-10T15:49:32.4086227Z",
  "updatedAt": "2023-12-12T15:49:32.4086253Z",
  "customer": {
   "customerId": "437c1744-f208-4afb-b46c-b93ea16d995e",
   "firstName": "Martin",
   "lastName": "John",
   "countryCode": "DE",
   "email": "martin.john@gmail.com",
   "name": "Martin John"
  },
  "client": {
   "id": 1,
   "name": "ABC",
   "email": "info@abc.de",
   "countryCode": "DE",
   "country": "Germany"
  }
 }
]