riverty logo

Docs
Get Started Login

Get All Shop Disputes

Get all disputes for such client. This endpoint returns a list of disputes that the customers
submitted on products owned by a client.

This endpoint supports filtering out results based on dispute status and also all disputes
for a specific time period.

Path

GET /disputes

Request Parameters

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

200 Successful Request

Request Example

    
        {
 "countryCode": "market country code for the shop",
 "shopId": "unique identifier for the shop",
 "sortBy": "(optional) sort results by a property. By default, CreatedAt. Available values : CreatedAt, StatusId, ReasonCodeId, TicketNumber, Deadline",
 "sortMethod": "(optional) select the sorting method to be asc or desc. By default, desc.",
 "query": "(optional) query is a key to search for a dispute by invoice number or ticket number.",
 "status": "(optional) status is status of dispute.",
 "startDate": "(optional) startDate is the earliest creation time of the dispute to be considered.",
 "endDate": "(optional) endDate is the latest creation time of the dispute to be considered.",
 "pageSize": 20,
 "pageNumber": 1
}

Response Example

    
        {
 "results": [
  {
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "customerId": "string",
   "clientId": 0,
   "source": "string",
   "reasonCode": {
    "reasonCodeId": 0,
    "name": "string"
   },
   "description": "string",
   "invoiceId": "string",
   "invoiceNumber": "string",
   "ticketNumber": "string",
   "invoiceDate": "2024-05-24",
   "amount": "string",
   "disputeAmount": "string",
   "orderId": "string",
   "orderNumber": "string",
   "trackingId": "string",
   "consumerLanguage": "string",
   "clientLanguage": "string",
   "attachments": [
    {
     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "fileName": "string",
     "originalFileName": "string",
     "createdAt": "2024-05-24T08:05:40.571Z",
     "size": 0,
     "mimeType": "string",
     "url": "string"
    }
   ],
   "clientDisputeStatus": {
    "id": 0,
    "name": "string"
   },
   "customerDisputeStatus": {
    "id": 0,
    "name": "string"
   },
   "createdAt": "2024-05-24T08:05:40.571Z",
   "updatedAt": "2024-05-24T08:05:40.571Z",
   "customer": {
    "customerId": "string",
    "firstName": "string",
    "lastName": "string",
    "countryCode": "string",
    "email": "string"
   },
   "client": {
    "id": 0,
    "name": "string",
    "email": "string",
    "countryCode": "string",
    "country": "string",
    "shopId": "string"
   },
   "stage": {
    "id": 0,
    "name": "string",
    "deadline": "2024-05-24T08:05:40.571Z"
   },
   "decision": {
    "id": 0,
    "name": "string"
   }
  }
 ],
 "paging": {
  "total": 0,
  "pageSize": 0
 }
}