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
Enum:

CreatedAt

StatusId

ReasonCodeId

TicketNumber

Deadline

UpdatedByConsumerOrRivertyAt

AgentAssignee

(optional) sort results by a property. By default, CreatedAt.
sortMethod
string
Enum:

Desc

Asc

(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.
startDate
string <date-time>
(optional) startDate is the earliest creation time of the dispute to be considered.
endDate
string <date-time>
(optional) endDate is the latest creation time of the dispute to be considered.
pageSize
integer <int32> default: 20
(optional) number of items per page. Default is 20.
pageNumber
integer <int32> default: 1
(optional) jump to a page. Default is 1

Responses

200 Successful Request

Request Example

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

Response Example

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