getVeroReportItems: eBay Vero API | eBay Developers Program

GET/vero_report_items

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 one or more VeRO reported items you have submitted.

Without the use of any query parameters, the default behavior of this method is to return the status of all VeRO reported items submitted by the seller during the last two years. Use the itemId query parameter to see a specific reported item, and use the filter query to retrieve the status of reported items submitted within a specific date range. Pagination is also available to limit the number of reported items that are retrieved per page of data.

Input

Resource URI

GET https://api.ebay.com/commerce/vero/v1/vero_report_items?

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
itemId	string	This query parameter specifies the unique identifier of an eBay listing. Only the specified reported item will be returned. Occurrence: Optional
limit	integer	The maximum number of entries that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output. Note: This feature employs a zero-based list, where the first item in the list has an offset of `0`. For example, if offset is set to `10` and limit is set to `10`, the call retrieves entries 11 through 20 from the result set. If this parameter is omitted, the default value is used. Default: 25 Occurrence: Optional
offset	integer	The number of reports to skip in the result set before returning the first report in the paginated response. Combine offset with the limit query parameter to control the reports returned in the response. For example, if you supply an offset of `0` and a limit of `10`, the first page of the response contains the first 10 reports from the complete list of reports retrieved by the call. If this query parameter is not set, the default value is used and the first page of reports is returned. Default: 0 Occurrence: Optional
filter	string	This query parameter can be used to filter the result set by a date range. Only items reported within the specified time period will be returned. This parameter will be ignored if itemId has been specified. Format: `YYYY-MM-DD HH:MM:SS` Example: `reportSubmittedDate:[2024-11-14T07:47:48Z..2024-12-14T07:47:48Z]`. Occurrence: Optional

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/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

Copy complete valid JSON to clipboard

{ /* VeroReportStatusResponse */

"href" : "string",

"limit" : "integer",

"next" : "string",

"offset" : "integer",

"prev" : "string",

"reportedItemDetails" : [

{ /* ReportedItem */

"itemId" : "string",

"reasonForFailure" : "string",

"status" : "VeroReportedItemStatusEnum : [NONE,RECEIVED,SUBMITTED...]"

}

"total" : "integer"

}

Response fields

Output container/field	Type	Description
href	string	The URL to the current page of the VeRO reported item results. Occurrence: Always
limit	integer	The value of the limit parameter submitted in the request. Occurrence: Always
next	string	The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set Occurrence: Conditional
offset	integer	The value off the offset parameter submitted in the request. Occurrence: Always
prev	string	The URI for the previous page of results. This is returned if there is a previous page of results from the result set. Occurrence: Conditional
reportedItemDetails	array of ReportedItem	This array returns the item ID and statuses of the reported items being returned. 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. This field is conditionally returned if the status value of the report is `ClarificationRequired` or `SubmissionFailed`. Occurrence: Conditional
reportedItemDetails.status	VeroReportedItemStatusEnum	The current status of the VeRO reported item. Occurrence: Conditional
total	integer	This is the total number of records that match the input criteria. Occurrence: Conditional

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
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.
235005	API_VERO	REQUEST	A filter supplied in the request is invalid: {filterName}
235006	API_VERO	REQUEST	The itemId was not found.
235007	API_VERO	REQUEST	Please check the date range.
235009	API_VERO	REQUEST	The time interval specified is greater than what is allowed (90 days is the maximum).
235010	API_VERO	REQUEST	Not authorized to perform this operation. Vero report creator and requester are different.

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 VeRO reported items from a specified time period

This method can be used to retrieve status information about the items you have submitted to eBay for VeRO report during a specified time period for copyright, trademark, or other intellectual property rights infringement.

Input

The filter query parameter can be used to specify a certain time period for which to retrieve VeRO reported items. In this sample, all items reported on November 11th, 2024 (2024-11-13T00:00:00.000Z) will be returned.

GEThttps://api.ebay.com/commerce/vero/v1/vero_report_item?filter=reportSubmittedDate:[2024-11-13T00:00:00.000Z]

Output

If the call is successful, an array of each reported item and their statuses are returned in the reportedItemDetails array.

{
    "offset": 0,
    "limit": 25,
    "next": "/vero_report_item?reportSubmittedDate:[2024-11-13T00:00:00.000Z]&limit=25&offset=25",
    "reportedItemDetails": [
        {
            "itemId": "2********2",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********8",
            "status": "SUBMITTED"
        },
        {
            "itemId": "1********1",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********2",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********3",
            "status": "SUBMITTED"
        },
        {
            "itemId": "1********1",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********5",
            "status": "SUBMITTED"
        },
        {
            "itemId": "1********7",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********5",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********5",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********2",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********7",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********2",
            "status": "SUBMITTED"
        },
        {
            "itemId": "1********1",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********2",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********5",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********5",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********7",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********6",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********2",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********0",
            "status": "SUBMITTED"
        },
        {
            "itemId": "1********1",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********2",
            "status": "SUBMITTED"
        },
        {
            "itemId": "2********6",
            "status": "SUBMITTED"
        },
        {
            "itemId": "1********1",
            "status": "SUBMITTED"
        }
    ],
    "href": "/vero_report_items?reportSubmittedDate:[2024-11-13T00:00:00.000Z]&limit=25&offset=0",
    "total": 685
}