createVeroReport: eBay Vero API | eBay Developers Program

POST/vero_report

Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.

This method can be used to create a VeRO report for a listing. VeRO reports can be used to report items that your copyright, trademark, or other intellectual property rights.

The itemId of the item being reported must be provided in the request, as well as the veroReasonCodeId of the claimed infringement.

You can report one or more items at a time using this method. A maximum of 150 items can be reported using this method.

Input

Resource URI

POST https://api.ebay.com/commerce/vero/v1/vero_report

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

This method has no URI parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Header	Type	Description
Content-Type	string	This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required

Header

Type

Description

Content-Type

string

This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

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

Copy complete valid JSON to clipboard

{ /* VeroReportItemsRequest */

"reportItems" : [

{ /* ReportItemDetails */

"brand" : "string",

"copyEmailToRightsOwner" : "boolean",

"countries" : [

"CountryCodeEnum : [AD,AE,AF...]"

"detailedMessage" : "string",

"itemId" : "string",

"messageToSeller" : "string",

"patent" : "string",

"regions" : [

"WorldRegionEnum : [AFRICA,AMERICAS,ASIA...]"

"veroReasonCodeId" : "string"

}

]

}

Request fields

Input container/field	Type	Description
reportItems	array of ReportItemDetails	This array is used to report one or more eBay items that are allegedly violating the product owner's copyright, trademark, or intellectual property rights. The itemId and veroReasonCodeId fields are required for each reported violation. Note: You can report the same item more than once if a different reason code is used each time. Occurrence: Required
reportItems.brand	string	The brand name of the item being reported for VeRO violation. Max length: 50 characters Occurrence: Optional
reportItems.copyEmailToRightsOwner	boolean	If the VeRO Program member wants a copy of the Notice of Claimed Infringement (NOCI) document sent to their email address, this field should be included in the request and set to `true`. This same document is automatically sent to the seller of the reported item. As this field defaults to `true, the report will be automatically emailed if this field is omitted. Default: true` `Occurrence: Optional`
reportItems.countries	array of CountryCodeEnum	If the infringement type stated in the VeroReasonCodeId has anything to do with which country the item is being shipped to, each country that would trigger this infringement type should be specified in this comma-delimited array. This field is required when the veroReasonCodeId is `9037` (Item(s) is unlawful importation of product bearing trademark). Occurrence: Conditional
reportItems.detailedMessage	string	This field is used to provide further information about the VeRO reason code. This field is required when the veroReasonCodeId is `9052` or `7052` (Other - Provide details information in additional information box below). Max length: 1000 characters Occurrence: Conditional
reportItems.itemId	string	The unique identifier of the listing being reported for the alleged infringement. Occurrence: Required
reportItems.messageToSeller	string	This field is used by the VeRO Program member to provide more details to the seller as to why the item is being reported for the alleged infringement. Max length: 1000 characters Occurrence: Optional
reportItems.patent	string	This field is used to specify the number of a product patent that is being violated. This field is required when the veroReasonCodeId is `9048` (Item(s) infringes a valid patent). Max length: 15 characters Occurrence: Conditional
reportItems.regions	array of WorldRegionEnum	If the infringement type stated in the veroReasonCodeId has anything to do with which geographical region the item is being shipped to, each region that would trigger this infringement type should be specified in this comma-delimited array. Occurrence: Conditional
reportItems.veroReasonCodeId	string	The unique identifier for the type of claimed infringement. Use getVeroReasonCodes to retrieve a list of valid reason codes for a given eBay site. Occurrence: Required

Output

HTTP response headers

See HTTP response headers for details.

Header	Meaning
Location	The Location response header returns the created report resource location.

Response payload

Copy complete valid JSON to clipboard

{ /* VeroReportItemsResponse */

"veroReportId" : "string",

"veroReportStatus" : "VeroReportStatusEnum : [RECEIVED,IN_PROCESS,PROCESSED]"

}

Response fields

Output container/field	Type	Description
veroReportId	string	The unique identifier of the VeRO report that the item violations have been added to. Note: Users should keep track of the returned veroReportId, as there is no programmatic way to retrieve this value at this time. Occurrence: Always
veroReportStatus	VeroReportStatusEnum	The processing status of the VeRO report. Occurrence: Always

Output container/field

Type

Description

veroReportId

string

The unique identifier of the VeRO report that the item violations have been added to.

Note: Users should keep track of the returned veroReportId, as there is no programmatic way to retrieve this value at this time.

Occurrence: Always

veroReportStatus

VeroReportStatusEnum

The processing status of the 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
201	Created
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.
235012	API_VERO	REQUEST	Number of reported items exceeds maximum limit of 150 items.
235013	API_VERO	REQUEST	The itemId is required for this call.
235014	API_VERO	REQUEST	The veroReasonCodeId is required for this call.
235015	API_VERO	REQUEST	At least one country is required for the specified reason code.
235016	API_VERO	REQUEST	The Regions specified are not allowed
235017	API_VERO	REQUEST	The patent is required for this call.
235018	API_VERO	REQUEST	Please verify patent, it should not exceed 15 characters.
235019	API_VERO	REQUEST	Please verify brand, it should not exceed 50 characters.
235020	API_VERO	REQUEST	The detailedMessage is required for the specified reason code.
235021	API_VERO	REQUEST	Please verify detailedMessage, it should not exceed 1000 characters.
235022	API_VERO	REQUEST	Please verify messageToSeller, it should not exceed 1000 characters.
235023	API_VERO	REQUEST	Please check report, there are duplicate item reports. A duplicate report is two report on the same itemId and veroReasonCodeId combination in one packet. The same combination itemId and veroReasonCodeId can be reported in a different packet.
235024	API_VERO_REPORT	REQUEST	At least one item is required for this call.

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: Create a VeRO report

This method can be used to create a VeRO report for a listing. VeRO reports can be used to report items that infringe on your copyright, trademark, or other intellectual property rights.

Input

The itemId of the item being reported must be provided in the request, as well as the veroReasonCodeId of the claimed infringement (in this case 9038, a trademark infraction). As this infraction is related to a specific location (US), the countries and regions arrays are included. A message to the seller has also been included in the request.

POSThttps://api.ebay.com/commerce/vero/v1/vero_report

Output

If the call is successful, HTTP status code 201 Created is returned, alongside the ID and current status of the report.