v1

latestOpenAPI 3.0.32026-08-06150495.9 KB

Dispute Manager API

Set Auto Dispute

Dispute Manager API - Set Auto Dispute

This endpoint enables automatic dispute functionality for specified listing IDs on a particular channel. Once enabled, all disputed orders associated with those listing IDs will be automatically disputed by the system, streamlining the dispute resolution process.

Request

HTTP Method

POST

URL

{{base-url}}/v1/dispute-manager/auto-dispute/set-auto-dispute

Request Body

The request body must be in JSON format and includes the following parameters:

Key	Type	Description
stores	array	An array of listing/store IDs for which auto dispute should be enabled.
channel	string	The channel for which to enable auto dispute (e.g., DOORDASH, UBEREATS, GRUBHUB).

Example Request Body

{
    "stores": [
        "P3781",
        "P3782",
        "P3783",
        "P3784",
        "P3785",
        "P3786",
        "P3787"
    ],
    "channel": "DOORDASH"
}

Response

Response Body

The response will be in JSON format and contains the following structure:

Key	Type	Description
status	boolean	Indicates the success of the request.
statusCode	integer	A code representing the status of the request (200 for success).
message	string	A message providing additional information about the request.
error	null	Contains error details if the request was unsuccessful.

Example Response

{
  "status": true,
  "statusCode": 200,
  "message": "Auto dispute details saved successfully",
  "error": null
}

Status Codes

200 OK: The request was successful, and auto dispute has been enabled for the specified listings.
Other Status Codes: Refer to the API documentation for additional status codes and their meanings.

This endpoint is essential for automating the dispute management process, allowing businesses to efficiently handle disputes across multiple listings without manual intervention.

post/v1/dispute-manager/auto-dispute/set-auto-dispute

Headers

tokenstring

Example:{{access-token}}

(required) – JWT authentication token for secure access to the API.

x-api-keystring

Example:YOUR_API_KEY_HERE

(required) – API key for authentication.

Request body

storesstring[]

channelstring

Example request

{
  "stores": [
    "P3781",
    "P3782",
    "P3783",
    "P3784",
    "P3785",
    "P3786",
    "P3787"
  ],
  "channel": "DOORDASH"
}

Response

200

statusboolean

statusCodenumber

messagestring

{"stackTrail":"paths:/v1/dispute-manager/auto-dispute/set-auto-dispute:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}

Example response

{
  "status": true,
  "statusCode": 200,
  "message": "Auto dispute details saved successfully"
}