latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Commerce Disputes
Get a list of orders disputes for a business
get/commerce/disputes
Query parameters
businessNamestring required
Unique business name identifier.
serviceName'shopify' | 'square' required
Name of commerce service.
offsetnumber
The offset is the position in the dataset of a particular record.
limitnumber
This is the size of the results set you would like (default: 100).
orderBystring
idstring
status'evidenceRequired' | 'inquiryProcessing' | 'processing' | 'inquiryClosed' | 'chargeRefunded' | 'inquiryAccepted' | 'inquiryWon' | 'inquiryLost' | 'unknown' | 'other'
startDatestring
endDatestring
Response
Example response
{
"count": 1,
"data": [
{
"id": "1052608616",
"totalAmount": 100,
"status": "processing",
"reason": "subscriptionCanceled",
"dueDate": "2022-03-11T11:29:03-05:00\"",
"createdDate": "2022-03-11T11:29:03-05:00\"",
"sourceModifiedDate": "2022-03-11T11:29:03-05:00\"",
"orderRef": {
"id": "625362839",
"orderNumber": "1001"
},
"currencyRef": {
"symbol": "CAD",
"name": "Canadian Dollar"
}
}
],
"meta": {
"reportId": [
"5fad8a342a88364234392fb5"
],
"serviceName": "xero",
"businessName": "Railz",
"createdAt": "2020-11-25T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z",
"startDate": "2020-11-25T01:02:03Z",
"endDate": "2020-11-30T01:02:03Z"
}
}