GET/vero_reason_code/{vero_reason_code_id}
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 a specific VeRO reason code, including a description of the code and the marketplace associated with the code.
The vero_reason_code_id of the VeRO reason code for which to retrieve details is required as a path parameter.
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 |
|---|---|---|
| vero_reason_code_id | string | This path parameter specifies the unique identifier of the VeRO reason code that is to be retrieved. Use the getVeroReasonCodes method to retrieve supported VeRO reason code IDs. 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 |
|---|---|---|
| marketplaceId | MarketplaceIdEnum | The eBay site for which reason code details are returned. Occurrence: Conditional |
| reasonCodeDetails | 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: Conditional |
| reasonCodeDetails.briefText | string | The short description of the infringement associated with the reason code. Occurrence: Always |
| reasonCodeDetails.detailedText | string | The long description of the infringement associated with the reason code. Occurrence: Always |
| 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. |
| 235001 | API_VERO | REQUEST | The veroReasonCodeId was not found. |
| 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 the details of a specific VeRO reason code
This method returns the details, including the description and associated marketplace, of a specified VeRO reason code.
Input
The vero_reason_code_id for which to retrieve details is required in the path parameter of the call.
GEThttps://api.ebay.com/commerce/vero/v1/vero_reason_code/9052
Output
If the call is successful, details about the specified VeRO reason code are returned. This includes a brief description of the code (briefText), a detailed description of the code (detailedText), and the marketplace associated with the code (marketplaceId).