Dispute
Commerce Disputes

GET /commerce/disputes

Changed on

Get a list of orders disputes for a business

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required
Example:Railz

Unique business name identifier.

serviceName'shopify' | 'square' required
Example:shopify

Name of commerce service.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber
Example:100

This is the size of the results set you would like (default: 100).

orderBystring
idstring
Example:12345
status'evidenceRequired' | 'inquiryProcessing' | 'processing' | 'inquiryClosed' | 'chargeRefunded' | 'inquiryAccepted' | 'inquiryWon' | 'inquiryLost' | 'unknown' | 'other'
Example:processing
startDatestring
Example:2014-04-25
endDatestring
Example:2014-04-25

Response

countnumber required

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"
  }
}

Changes

    • info

      api tag Dispute added

    • warning

      added the new byod enum value to the / response property for the response status

    • warning

      added the new byod enum value to the / response property for the response status

    • warning

      added the new dynamics365Finance enum value to the / response property for the response status

    • warning

      added the new dynamics365Finance enum value to the / response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the / response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the / response property for the response status

    • warning

      added the new freshbooks enum value to the / response property for the response status

    • warning

      added the new freshbooks enum value to the / response property for the response status

    • warning

      added the new myob enum value to the / response property for the response status

    • warning

      added the new myob enum value to the / response property for the response status

    • warning

      added the new oracleNetsuite enum value to the / response property for the response status

    • warning

      added the new oracleNetsuite enum value to the / response property for the response status

    • warning

      added the new quickbooks enum value to the / response property for the response status

    • warning

      added the new quickbooks enum value to the / response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the / response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the / response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the / response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the / response property for the response status

    • warning

      added the new sageIntacct enum value to the / response property for the response status

    • warning

      added the new sageIntacct enum value to the / response property for the response status

    • warning

      added the new wave enum value to the / response property for the response status

    • warning

      added the new wave enum value to the / response property for the response status

    • warning

      added the new xero enum value to the / response property for the response status

    • warning

      added the new xero enum value to the / response property for the response status

    • warning

      added the new zohoBooks enum value to the / response property for the response status

    • warning

      added the new zohoBooks enum value to the / response property for the response status