Voosh API Documentation (1.0.0)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

This endpoint retrieves disputed orders based on the provided query parameters.

Request

• Method: GET

• URL: {{base-url}}/disputed-manger/orders

• Query Parameters:

  • limit (integer, optional): The maximum number of orders to retrieve.

  • offset (integer, optional): The offset for paginating through a large result set.

  • clientId (string, required): The unique identifier of the client.

• { "startDate": "YYYY-MM-DD", "endDate": "YYYY-MM-DD", "listingIds": ["string"], "channel": ["string"]}

  • startDate (string): The start date for the order search.

  • endDate (string): The end date for the order search.

  • listingIds (array of strings): The IDs of the listings to filter the orders.

  • channel (array of strings): The channels to filter the orders.

Response

The response for this request can be represented as a JSON schema:

{
  "type": "object",
  "properties": {
    "status": {"type": "boolean"},
    "statusCode": {"type": "integer"},
    "message": {"type": "string"},
    "result": {
      "type": "object",
      "properties": {
        "total": {"type": "integer"},
        "orders": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "deliveryUUID": {"type": "string"},
              "customerName": {"type": "string"},
              "storeId": {"type": "string"},
              "listingId": {"type": "string"},
              "brandId": {"type": "string"},
              "channel": {"type": "string"},
              "disputeEligibility": {"type": "boolean"},
              "disputeStatus": {"type": "string"},
              "disputeDate": {"type": "string"},
              "statusUpdateDate": {"type": "string"},
              "disputeIssue": {"type": "string"},
              "disputeReason": {"type": ["string", "null"]},
              "disputeDescription": {"type": ["string", "null"]},
              "disputeAmount": {"type": "number"},
              "disputeWonAmount": {"type": "number"},
              "disputeLostAmount": {"type": "number"},
              "disputeItemDetails": {"type": "string"},
              "disputeByVoosh": {"type": "boolean"},
              "isAutoDispute": {"type": "boolean"},
              "ineligibleForDisputeReason": {"type": "string"}
            }
          }
        }
      }
    },
    "error": {"type": ["object", "null"]}
  }
}

Request

This endpoint makes an HTTP GET request to retrieve auto-dispute configurations for a specific client. The request should include the client_id as a query parameter in the URL. The last call to this request used the following payload with the raw request body type:

{
    "listingIds": ["P8521"],
    "channel": ["DOORDASH"]
}

Response

The response will include a status, status code, message, and a result array containing auto-dispute configurations. Each configuration in the result array includes the following details:

• id (string): The identifier for the auto-dispute configuration.

• channel (string): The channel for which the configuration is applicable.

• stores (string): The stores associated with the configuration.

• error (string): Any error associated with the configuration.

• reason (string): The reason for the dispute.

• description (string): Additional description for the configuration.

• isActive (integer): Indicates if the configuration is active.

• refundPercentage (integer): The refund percentage associated with the configuration.

• manuallyCreated (integer): Indicates if the configuration was manually created.

• createdAt (string): The date and time when the configuration was created.

Example Response

{
    "status": true,
    "statusCode": 0,
    "message": "",
    "result": [
        {
            "id": "",
            "channel": "",
            "stores": "",
            "error": "",
            "reason": "",
            "description": null,
            "isActive": 0,
            "refundPercentage": null,
            "manuallyCreated": 0,
            "createdAt": ""
        }
    ],
    "error": null
}

This endpoint allows the user to set an auto dispute for a specific client and channel.

Request Body

• channel (string) - The channel for which the auto dispute is to be set.

• stores (array) - An array of store IDs for which the auto dispute is to be set.

Example:

{
    "channel": "SKIP_THE_DISHES",
    "stores": ["P9721"]
}

Response

• status (boolean) - Indicates the status of the request.

• statusCode (integer) - The status code of the response.

• message (string) - A message related to the response.

• result (object) - The result of the request.

  • status (boolean) - Indicates the status of the result.

  • message (string) - A message related to the result.

• error (null) - Indicates any error in the response.

Example:

{
    "status": true,
    "statusCode": 0,
    "message": "",
    "result": {
        "status": true,
        "message": ""
    },
    "error": null
}

This endpoint allows users to manually raise a dispute by providing the delivery UUID, reason for the dispute, and an optional description.

Request Body

• deliveryUUID (string): The unique identifier for the delivery.

• reason (string): The reason for raising the dispute.

• description (string, optional): Additional description for the dispute.

Example Request:

{
    "deliveryUUID": "622f87af-8ced-41d0-9256-32e808 ...",
    "reason": "CUSTOMER_MISTAKE",
    "description": ""
}

Response

• status (boolean): Indicates the status of the request.

• statusCode (integer): The status code of the response.

• message (string): A message related to the response status.

• result (object): An object containing the status and message.

• error (null): Indicates the absence of any error in the response.

Example Response:

{
    "status": true,
    "statusCode": 0,
    "message": "",
    "result": {
        "status": true,
        "message": ""
    },
    "error": null
}

This endpoint allows you to manually configure auto-dispute settings for a specific client.

Request Body

• channel (string) - The channel for which the dispute configuration is being set.

• reason (string) - The reason for the dispute configuration.

• error (string) - The error type for which the dispute configuration is being set.

• description (string) - Additional description for the dispute configuration.

• stores (string) - The specific store(s) for which the dispute configuration is being set.

• refundPercentage (string) - The percentage of refund for the dispute configuration.

Response

• status (boolean) - Indicates the status of the request.

• statusCode (integer) - The status code of the response.

• message (string) - A message related to the status of the request.

• result (object) - The result of the request, including its status and message.

• error (null) - Any error message, if applicable.

Example Response:

{
    "status": true,
    "statusCode": 0,
    "message": "",
    "result": {
        "status": true,
        "message": ""
    },
    "error": null
}

This endpoint retrieves the configuration details for auto-dispute functionality based on the provided client ID.

Request

• Method: GET

• URL: {{base-url}}/disputed-manger/auto-dispute/get-config-details

• Query Parameters:

  • client_id (string, required): The unique client ID for which the configuration details are requested.

Response

The response will contain the following fields:

• listings (number): The number of listings.

• listingIds (array): An array of objects containing listingsId and restaurantName.

• channel (array): An array of channels.

• channelWiseConfig (object): An object containing configuration details for different channels such as DOORDASH and UBEREATS.

  • DOORDASH (object): Configuration details for the DOORDASH channel.

    • ENTIRELY_WRONG_ORDER (array): Array of reasons for entirely wrong orders.

    • WRONG_ORDER (array): Array of reasons for wrong orders.

    • INGREDIENT_ERROR (array): Array of reasons for ingredient errors.

    • INCORRECT_SIZE (array): Array of reasons for incorrect sizes.

    • INCORRECT_QUANTITY (array): Array of reasons for incorrect quantities.

    • MISSING_SIDE_ITEM (array): Array of reasons for missing side items.

  • UBEREATS (object): Configuration details for the UBEREATS channel.

    • PARTIAL_MISSING_ITEMS (array): Array of reasons for partially missing items.

    • NEVER_RECEIVED (array): Array of reasons for items never received.

    • MISCELLANEOUS (array): Array of miscellaneous reasons.

    • MISSING_ITEMS (array): Array of reasons for missing items.

    • WRONG_ORDER (array): Array of reasons for wrong orders.

    • MISSING (array): Array of reasons for missing items.

    • INCOMPLETE (array): Array of reasons for incomplete orders.

    • FOOD_DAMAGED (array): Array of reasons for damaged food.

  • info (string): Additional information.