GET/vero_report/{vero_report_id}
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method can be used to retrieve status information about a VeRO report you have submitted to eBay for copyright, trademark, or other intellectual property rights infringement.
The vero_report_id path parameter is used to specify the eBay report for which to retrieve status information.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| includeItemDetails | boolean | Include this query and set it to true if you want to retrieve the reportedItemDetails container in the response, which contains item-level status information. This container may be helpful if you have reported violations on more than one eBay item in the report.By default, this boolean is set to false. Occurrence: Optional |
| vero_report_id | string | This path parameter specifies the unique identifier of the VeRO report being retrieved. This value is returned when creating a VeRO report through the createVeroReport method. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/commerce.vero
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| reportedItemDetails | array of ReportedItem | This array returns the status for each eBay item that was included as part of the report. Occurrence: Conditional |
| reportedItemDetails.itemId | string | The unique identifier of the listing that is being reported for copyright, trademark, or intellectual right infringement. Occurrence: Conditional |
| reportedItemDetails.reasonForFailure | string | This text explanation is submitted by eBay when the submission of a VeRO Report has failed or was blocked. Occurrence: Conditional |
| reportedItemDetails.status | VeroReportedItemStatusEnum | The current status of the VeRO reported item. Occurrence: Conditional |
| veroReportId | string | The unique packet identifier of the VeRO report. Occurrence: Always |
| veroReportStatus | VeroReportStatusEnum | The processing status of the requested VeRO report. Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 235000 | API_VERO | APPLICATION | There was a problem with an eBay internal system or process. |
| 235002 | API_VERO | REQUEST | Only Registered Verified Rights Owners are allowed. Subscription missing. |
| 235003 | API_VERO | REQUEST | Only Registered Verified Rights Owners are allowed. Insufficient subscription level. |
| 235010 | API_VERO | REQUEST | Not authorized to perform this operation. Vero report creator and requester are different. |
| 235011 | API_VERO | REQUEST | The veroReportId was not found. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Retrieve a VeRO report
This method can be used to retrieve status information about a specific VeRO report you have submitted to eBay for copyright, trademark, or other intellectual property rights infringement.
Input
The vero_report_id of the VeRO report for which to retrieve status information is required in the path parameter of the call.
GEThttps://api.ebay.com/commerce/vero/v1/vero_report/5********
Output
If the call is successful, the status of the VeRO report is returned, as well as the reported item details (if the includeItemDetails boolean was set to true). In this sample, just the report status has been returned.