Vero Public API's — client.commerce.vero¶
Version 1.0.0 · base path /commerce/vero/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_vero_reason_code ¶
get_vero_reason_code(vero_reason_code_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_vero_models.VeroReasonCodeResponse
get_vero_reason_code(vero_reason_code_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_vero_reason_code(vero_reason_code_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_vero_models.VeroReasonCodeResponse | httpx.Response
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.
get_vero_reason_codes ¶
get_vero_reason_codes(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_vero_models.VeroReasonCodeDetailResponse
get_vero_reason_codes(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_vero_reason_codes(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_vero_models.VeroReasonCodeDetailResponse | httpx.Response
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.
create_vero_report ¶
create_vero_report(*, body: VeroReportItemsRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_vero_models.VeroReportItemsResponse
create_vero_report(*, body: VeroReportItemsRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_vero_report(*, body: VeroReportItemsRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_vero_models.VeroReportItemsResponse | httpx.Response
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.
get_vero_report ¶
get_vero_report(vero_report_id: str, *, include_item_details: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_vero_models.ReportStatusResponse
get_vero_report(vero_report_id: str, *, include_item_details: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_vero_report(vero_report_id: str, *, include_item_details: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_vero_models.ReportStatusResponse | httpx.Response
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 a VeRO report you have submitted to eBay for copyright, trademark, or other intellectual property rights infringement. The vero_report_id path parameter is used to specify the eBay report for which to retrieve status information.
get_vero_report_items ¶
get_vero_report_items(*, filter: str | None = None, item_id: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_vero_models.VeroReportStatusResponse
get_vero_report_items(*, filter: str | None = None, item_id: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_vero_report_items(*, filter: str | None = None, item_id: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_vero_models.VeroReportStatusResponse | httpx.Response
Retrieves status for VERO infringement reports by Brand.
Models¶
CountryCodeEnum ¶
Bases: OpenStrEnum
ErrorParameter ¶
MarketplaceIdEnum ¶
Bases: OpenStrEnum
ReasonCodeDetailType ¶
Bases: EbayModel
brief_text
class-attribute
instance-attribute
¶
brief_text = Field(None, alias='briefText', description='The short description of the infringement associated with the reason code.')
detailed_text
class-attribute
instance-attribute
¶
detailed_text = Field(None, alias='detailedText', description='The long description of the infringement associated with the reason code.')
vero_reason_code_id
class-attribute
instance-attribute
¶
vero_reason_code_id = Field(None, alias='veroReasonCodeId', description='The unique identifier of a VeRO reason code.')
VeroReasonCode ¶
Bases: EbayModel
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The eBay site for which reason code details are returned.')
reason_code_details
class-attribute
instance-attribute
¶
reason_code_details = Field(None, alias='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.')
VeroReasonCodeDetailResponse ¶
Bases: EbayModel
vero_reason_codes
class-attribute
instance-attribute
¶
vero_reason_codes = Field(None, alias='veroReasonCodes', 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.')
VeroReasonCodeResponse ¶
Bases: EbayModel
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The eBay site for which reason code details are returned.')
reason_code_details
class-attribute
instance-attribute
¶
reason_code_details = Field(None, alias='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')
VeroReportStatusEnum ¶
VeroReportedItemStatusEnum ¶
Bases: OpenStrEnum
clarification_required
class-attribute
instance-attribute
¶
clarification_required = 'CLARIFICATION_REQUIRED'
WorldRegionEnum ¶
Bases: OpenStrEnum
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of error.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
ReportItemDetails ¶
Bases: EbayModel
brand
class-attribute
instance-attribute
¶
brand = Field(None, description='The brand name of the item being reported for VeRO violation. Max length: 50 characters')
copy_email_to_rights_owner
class-attribute
instance-attribute
¶
copy_email_to_rights_owner = Field(None, alias='copyEmailToRightsOwner', description='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')
countries
class-attribute
instance-attribute
¶
countries = Field(None, 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).')
detailed_message
class-attribute
instance-attribute
¶
detailed_message = Field(None, alias='detailedMessage', 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')
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique identifier of the listing being reported for the alleged infringement.')
message_to_seller
class-attribute
instance-attribute
¶
message_to_seller = Field(None, alias='messageToSeller', 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
class-attribute
instance-attribute
¶
patent = Field(None, 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
class-attribute
instance-attribute
¶
regions = Field(None, 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.')
vero_reason_code_id
class-attribute
instance-attribute
¶
vero_reason_code_id = Field(None, alias='veroReasonCodeId', 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.')
ReportedItem ¶
Bases: EbayModel
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique identifier of the listing that is being reported for copyright, trademark, or intellectual right infringement.')
reason_for_failure
class-attribute
instance-attribute
¶
reason_for_failure = Field(None, alias='reasonForFailure', 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
class-attribute
instance-attribute
¶
status = Field(None, description='The current status of the VeRO reported item.')
VeroReportItemsRequest ¶
Bases: EbayModel
report_items
class-attribute
instance-attribute
¶
report_items = Field(None, alias='reportItems', 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.")
VeroReportItemsResponse ¶
Bases: EbayModel
vero_report_id
class-attribute
instance-attribute
¶
vero_report_id = Field(None, alias='veroReportId', 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.')
vero_report_status
class-attribute
instance-attribute
¶
vero_report_status = Field(None, alias='veroReportStatus', description='The processing status of the VeRO report.')
VeroReportStatusResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URL to the current page of the VeRO reported item results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request.')
next
class-attribute
instance-attribute
¶
next = Field(None, 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
class-attribute
instance-attribute
¶
offset = Field(None, description='The value off the offset parameter submitted in the request.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This is returned if there is a previous page of results from the result set.')
reported_item_details
class-attribute
instance-attribute
¶
reported_item_details = Field(None, alias='reportedItemDetails', description='This array returns the item ID and statuses of the reported items being returned.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='This is the total number of records that match the input criteria.')
ReportStatusResponse ¶
Bases: EbayModel
reported_item_details
class-attribute
instance-attribute
¶
reported_item_details = Field(None, alias='reportedItemDetails', 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 .')
vero_report_id
class-attribute
instance-attribute
¶
vero_report_id = Field(None, alias='veroReportId', description='The unique packet identifier of the VeRO report.')
vero_report_status
class-attribute
instance-attribute
¶
vero_report_status = Field(None, alias='veroReportStatus', description='The processing status of the requested VeRO report.')