Important!\ \ You must be a member of the Verified Rights Owner (VeRO) Program to use\ \ this call.
Important!\ \ You must be a member of the Verified Rights Owner (VeRO) Program to use\ \ this call.
Important!\ \ You must be a member of the Verified Rights Owner (VeRO) Program to use\ \ this call.
Important!\ \ You must be a member of the Verified Rights Owner (VeRO) Program to use\ \ this call.
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.false."
required: false
schema:
type: "string"
- name: "vero_report_id"
in: "path"
description: "This path parameter specifies the unique identifier of the VeRO\
\ report being retrieved.Important!\ \ You must be a member of the Verified Rights Owner (VeRO) Program to use\ \ this call.
YYYY-MM-DD HH:MM:SSreportSubmittedDate:[2024-11-14T07:47:48Z..2024-12-14T07:47:48Z]."
required: false
schema:
type: "string"
- name: "itemId"
in: "query"
description: "This query parameter specifies the unique identifier of an eBay\
\ listing. Only the specified reported item will be returned."
required: false
schema:
type: "string"
- name: "limit"
in: "query"
description: "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.0.10 and limit is\
\ set to 10, the call retrieves entries 11 through 20 from\
\ the result set.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.true. This\
\ same document is automatically sent to the seller of the reported item.true, the report will be automatically\
\ emailed if this field is omitted.
Default: true"
countries:
type: "array"
description: "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)."
items:
type: "string"
description: " For implementation help, refer to eBay\
\ API documentation"
detailedMessage:
type: "string"
description: "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"
itemId:
type: "string"
description: "The unique identifier of the listing being reported for the\
\ alleged infringement."
messageToSeller:
type: "string"
description: "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"
patent:
type: "string"
description: "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"
regions:
type: "array"
description: "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."
items:
type: "string"
description: " For implementation help, refer to eBay\
\ API documentation"
veroReasonCodeId:
type: "string"
description: "The unique identifier for the type of claimed infringement.
Use\
\ getVeroReasonCodes to retrieve a list of valid\
\ reason codes for a given eBay site."
description: "This type defines the details of an item being reported for violating\
\ a product owner's copyright, trademark, or intellectual property rights."
ReportStatusResponse:
type: "object"
properties:
reportedItemDetails:
type: "array"
description: "This array returns the status for each eBay item that was\
\ included as part of the report.
This array is only returned if\
\ the includeItemDetails query parameter is set to true."
items:
$ref: "#/components/schemas/ReportedItem"
veroReportId:
type: "string"
description: "The unique packet identifier of the VeRO report."
veroReportStatus:
type: "string"
description: "The processing status of the requested VeRO report. For implementation\
\ help, refer to eBay\
\ API documentation"
description: "This type defines the response fields of the getVeroReport\
\ method. "
ReportedItem:
type: "object"
properties:
itemId:
type: "string"
description: "The unique identifier of the listing that is being reported\
\ for copyright, trademark, or intellectual right infringement."
reasonForFailure:
type: "string"
description: "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."
status:
type: "string"
description: "The current status of the VeRO reported item. For implementation\
\ help, refer to eBay\
\ API documentation"
description: "This type defines the item ID and status of a VeRO report. If\
\ applicable, a reason for report failure is also returned."
VeroReasonCode:
type: "object"
properties:
marketplaceId:
type: "string"
description: "The eBay site for which reason code details are returned.\
\ For implementation help, refer to eBay\
\ API documentation"
reasonCodeDetails:
type: "array"
description: "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."
items:
$ref: "#/components/schemas/ReasonCodeDetailType"
description: "This type is used to define the details of a VeRO reason code\
\ for a specific site."
VeroReasonCodeDetailResponse:
type: "object"
properties:
veroReasonCodes:
type: "array"
description: "This array provides a list of VeRO reason codes, as well as\
\ the ID and details of each code, based on the input criteria.
If\
\ a X-EBAY-C-MARKETPLACE-ID header is used, 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. "
items:
$ref: "#/components/schemas/VeroReasonCode"
description: "This type defines the response fields returned in the getCeroReasonCodes\
\ method."
VeroReasonCodeResponse:
type: "object"
properties:
marketplaceId:
type: "string"
description: "The eBay site for which reason code details are returned.\
\ For implementation help, refer to eBay\
\ API documentation"
reasonCodeDetails:
description: "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"
$ref: "#/components/schemas/ReasonCodeDetailType"
VeroReportItemsRequest:
type: "object"
properties:
reportItems:
type: "array"
description: "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."
items:
$ref: "#/components/schemas/ReportItemDetails"
description: "This type defines the request fields used in the createVeroReport\
\ method."
VeroReportItemsResponse:
type: "object"
properties:
veroReportId:
type: "string"
description: "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."
veroReportStatus:
type: "string"
description: "The processing status of the VeRO report. For implementation\
\ help, refer to eBay\
\ API documentation"
description: "This type defines the response fields used in the createVeroReport\
\ method."
VeroReportStatusResponse:
type: "object"
properties:
href:
type: "string"
description: "The URL to the current page of the VeRO reported item results."
limit:
type: "integer"
description: "The value of the limit parameter submitted in the request."
format: "int32"
next:
type: "string"
description: "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"
offset:
type: "integer"
description: "The value off the offset parameter submitted in the\
\ request."
format: "int32"
prev:
type: "string"
description: "The URI for the previous page of results. This is returned\
\ if there is a previous page of results from the result set."
reportedItemDetails:
type: "array"
description: "This array returns the item ID and statuses of the reported\
\ items being returned."
items:
$ref: "#/components/schemas/ReportedItem"
total:
type: "integer"
description: "This is the total number of records that match the input criteria."
format: "int32"
description: "This type defines the response fields for the getVeroReports\
\ method."
securitySchemes:
api_auth:
type: "oauth2"
description: "The security definitions for this API. Please check individual\
\ operations for applicable scopes."
flows: {}