v1

latestOpenAPI 3.0.32026-08-06150495.9 KB

Dispute Manager API

Get All Disputed Orders

Dispute Manager API - Fetch Orders

This endpoint allows you to retrieve dispute manager orders associated with specific listings within a defined date range. You can specify the number of orders to return, as well as pagination and sorting options.

Request

HTTP Method

POST

URL

{{base-url}}/v1/dispute-manager/orders?limit=5&offset=1&order=-1

Request Body

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

Key	Type	Description
startDate	string	The start date for filtering orders (format: YYYY-MM-DD).
endDate	string	The end date for filtering orders (format: YYYY-MM-DD).
listingIds	array	An array of listing IDs to filter the orders.
channel	array	An array specifying the channels from which to fetch orders (e.g., DOORDASH, UBEREATS, GRUBHUB, DOORDASH_DRIVE).
showDummyData	boolean	Whether to show dummy data for testing purposes.

Example Request Body

{
    "startDate": "2025-10-12",
    "endDate": "2025-11-11",
    "listingIds": [
        "P67071",
        "P67073"
    ],
    "channel": [
        "DOORDASH",
        "UBEREATS",
        "GRUBHUB",
        "DOORDASH_DRIVE"
    ],
    "showDummyData": false
}

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.
result	object	Contains the main data returned from the API.

Result Structure

The result object contains the following keys:

Key	Type	Description
total	integer	The total number of orders matching the criteria.
orders	array	An array of order objects.

Orders Array Structure

Each object in the orders array contains the following fields:

Key	Type	Description
deliveryUUID	string	Unique identifier for the delivery.
orderId	string	Unique identifier for the order.
channel	string	The channel from which the order originated.
listingId	string	Unique identifier for the listing associated with the order.
storeId	string	Unique identifier for the store associated with the order.
brandId	string	Unique identifier for the brand associated with the order.
customerName	string	Name of the customer who placed the order.
status	string	Current status of the dispute (e.g., APPROVED, PENDING).
disputeReason	string/null	Reason for the dispute, if provided.
disputeDescription	string	Description of the dispute.
netPayout	object	Contains earnedAmount and lostAmount for the order.
date	string	The date of the order (ISO 8601 format).
dayLeftToDispute	integer	Number of days remaining to file a dispute.
autoDisputable	boolean	Indicates if the order can be auto-disputed.
disputable	boolean	Indicates if the order is disputable.
orderStatus	string	Status of the order (e.g., FULFILLED, CANCELLED).

Example Response

{
  "status": true,
  "statusCode": 200,
  "message": "Dispute manager orders fetched successfully",
  "result": {
    "total": 261,
    "orders": [
      {
        "deliveryUUID": "6ca2ce22-a795-11f0-8e23-5fcea5290c3e",
        "orderId": "534831330732971",
        "channel": "GRUBHUB",
        "listingId": "P67071",
        "storeId": "P6707",
        "brandId": "336",
        "customerName": "",
        "status": "APPROVED",
        "disputeReason": null,
        "disputeDescription": "MISSING_ITEM - Refund requested by diner via help interaction",
        "netPayout": {
          "earnedAmount": 4.69,
          "lostAmount": 0
        },
        "date": "2025-10-12T00:00:00.000Z",
        "dayLeftToDispute": 0,
        "autoDisputable": false,
        "disputable": false,
        "orderStatus": "FULFILLED"
      },
      {
        "deliveryUUID": "fee32e12-a77c-11f0-ae13-1f09dcce7fc7",
        "orderId": "894431330008472",
        "channel": "GRUBHUB",
        "listingId": "P67071",
        "storeId": "P6707",
        "brandId": "336",
        "customerName": "",
        "status": "APPROVED",
        "disputeReason": null,
        "disputeDescription": "MISSING_ITEM - Refund requested by diner via help interaction",
        "netPayout": {
          "earnedAmount": 9.01,
          "lostAmount": 0
        },
        "date": "2025-10-12T00:00:00.000Z",
        "dayLeftToDispute": 0,
        "autoDisputable": false,
        "disputable": false,
        "orderStatus": "FULFILLED"
      }
    ]
  }
}

Status Codes

200 OK: The request was successful, and the response contains the requested data.
Other Status Codes: Refer to the API documentation for additional status codes and their meanings.

This endpoint is essential for managing and analyzing dispute manager orders across different channels, helping businesses to respond effectively to order disputes.

post/v1/dispute-manager/orders

Query parameters

limitinteger

Example:5

(optional) – Specifies the number of orders to fetch. If not provided, the default value is 5.

offsetinteger

Example:1

(optional) – Specifies the starting point for fetching the records. Used for pagination. The default value is 0.

orderinteger

Example:-1

(optional) – Sort order for the results. Use -1 for descending order and 1 for ascending order.

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

channelstring[]

endDatestring

listingIdsstring[]

startDatestring

showDummyDataboolean

Example request

{
  "channel": [
    "DOORDASH",
    "UBEREATS",
    "GRUBHUB",
    "DOORDASH_DRIVE"
  ],
  "endDate": "2025-11-11",
  "listingIds": [
    "P67071",
    "P67073"
  ],
  "startDate": "2025-10-12"
}

Response

200 / 200

statusboolean

statusCodenumber

messagestring

Example response

{
  "status": true,
  "statusCode": 200,
  "message": "Dispute manager orders fetched successfully",
  "result": {
    "total": 261,
    "orders": [
      {
        "deliveryUUID": "6ca2ce22-a795-11f0-8e23-5fcea5290c3e",
        "orderId": "534831330732971",
        "channel": "GRUBHUB",
        "listingId": "P67071",
        "storeId": "P6707",
        "brandId": "336",
        "customerName": "",
        "status": "APPROVED",
        "disputeReason": null,
        "disputeDescription": "MISSING_ITEM - Refund requested by diner via help interaction",
        "netPayout": {
          "earnedAmount": 4.69,
          "lostAmount": 0
        },
        "date": "2025-10-12T00:00:00.000Z",
        "dayLeftToDispute": 0,
        "autoDisputable": false,
        "disputable": false,
        "orderStatus": "FULFILLED"
      },
      {
        "deliveryUUID": "fee32e12-a77c-11f0-ae13-1f09dcce7fc7",
        "orderId": "894431330008472",
        "channel": "GRUBHUB",
        "listingId": "P67071",
        "storeId": "P6707",
        "brandId": "336",
        "customerName": "",
        "status": "APPROVED",
        "disputeReason": null,
        "disputeDescription": "MISSING_ITEM - Refund requested by diner via help interaction",
        "netPayout": {
          "earnedAmount": 9.01,
          "lostAmount": 0
        },
        "date": "2025-10-12T00:00:00.000Z",
        "dayLeftToDispute": 0,
        "autoDisputable": false,
        "disputable": false,
        "orderStatus": "FULFILLED"
      }
    ]
  }
}