GET/vero_reason_code
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method is used to retrieve the details of an array of VeRO reason codes. This information includes the descriptions of each code, as well as the marketplace associated with each code.
If the X-EBAY-C-MARKETPLACE-ID header is present, only VeRO reason codes for that specific site will be returned. If this header is not included, all reason codes for all sites are returned.
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
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 |
|---|---|---|
| X-EBAY-C-MARKETPLACE-ID | string | This header identifies the eBay marketplace for which to retrieve VeRO reason codes. If this header is used, only VeRO reason codes for the specified marketplace will be returned in the response. See MarketplaceIdEnum for a list of supported values. Occurrence: Optional |
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 |
|---|---|---|
| veroReasonCodes | array of VeroReasonCode | This array provides a list of VeRO reason codes, as well as the ID and details of each code, based on the input criteria. Occurrence: Always |
| veroReasonCodes.marketplaceId | MarketplaceIdEnum | The eBay site for which reason code details are returned. Occurrence: Always |
| veroReasonCodes.reasonCodeDetails | array of ReasonCodeDetailType | This container includes both brief and detailed text descriptions for the VeRO program intellectual property right infringement reason, as well as the ID for the reason code. Occurrence: Always |
| veroReasonCodes.reasonCodeDetails.briefText | string | The short description of the infringement associated with the reason code. Occurrence: Always |
| veroReasonCodes.reasonCodeDetails.detailedText | string | The long description of the infringement associated with the reason code. Occurrence: Always |
| veroReasonCodes.reasonCodeDetails.veroReasonCodeId | string | The unique identifier of a VeRO reason code. 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 |
| 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. |
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 all VeRo reason codes on a specific marketplace
This method can be used to retrieve all the VeRO reason codes on a specified marketplace, as well as the details and IDs of each of these codes.
Input
The X-EBAY-C-MARKETPLACE-ID header can be used to specify the eBay marketplace for which to retrieve VeRO reason codes.
In this sample, all VeRO codes in the EBAY_US marketplace are returned.
GEThttps://api.ebay.com/commerce/vero/v1/vero_reason_code
Output
If the call is successful, an array of VeRO reason codes on the specified marketplace is returned. Each code will be returned with an associated briefText, detailedText, and veroReasonCodeId value.