The “report” API endpoint allows a user to report a product or an order to the admin. The user must provide the reason for the report and any supporting images or documents. The report can be for a product or an order, and the user must specify the type of report they are making.
Endpoint #
The Voomerr Report endpoint is POST https://admin.voomerr.com/api/report.php
Request Parameters #
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| user_id | Yes | string | The ID of the user submitting the report. |
| report_type_id | Yes | string | The ID of the type of report being submitted. |
| report | Yes | string | The content of the report being submitted. |
| product_order_date | No | string | The date of the product order. |
| report_images | No | array | An array of images related to the report being submitted. |
| product_id | No | string | The ID of the product related to the report being submitted. |
| order_id | No | string | The ID of the order related to the report being submitted. |
Response Parameters #
| Parameter Name | Type | Description |
|---|---|---|
| success | bool | Indicates whether the API call was successful or not. |
| message | string | A message indicating the result of the API call. |
| report_id | string | The ID of the report that was submitted (if successful). |
| errors | array | An array of error messages (if any) that occurred during validation |
Request Example #
json
{
"user_id": "1234",
"report_type_id": "1",
"report": "This product was damaged when I received it.",
"product_order_date": "2022-01-01",
"report_images": [
"https://example.com/image1.jpg",
"https://example.com/image2.jpg"
],
"product_id": "5678",
"order_id": "9012"
}
Response Example #
json
{
"success": true,
"message": "Report submitted successfully.",
"report_id": "3456",
"errors": []
}
