Compliance API — client.sell.compliance¶
Version 1.4.1 · base path /sell/compliance/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_listing_violations_summary ¶
get_listing_violations_summary(*, x_ebay_c_marketplace_id: str | None = None, compliance_type: str | None = None, raw_response: Literal[False] = False) -> sell_compliance_models.ComplianceSummary
get_listing_violations_summary(*, x_ebay_c_marketplace_id: str | None = None, compliance_type: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_listing_violations_summary(*, x_ebay_c_marketplace_id: str | None = None, compliance_type: str | None = None, raw_response: bool = False) -> sell_compliance_models.ComplianceSummary | httpx.Response
This call returns listing violation counts for a seller. A user can pass in one or more compliance types through the compliance_type query parameter. See ComplianceTypeEnum for more information on the supported listing compliance types. Listing violations are returned for multiple marketplaces if the seller sells on multiple eBay marketplaces.
get_listing_violations ¶
get_listing_violations(*, x_ebay_c_marketplace_id: str | None = None, compliance_type: str | None = None, offset: int | str | None = None, listing_id: str | None = None, limit: int | str | None = None, filter: str | None = None, raw_response: Literal[False] = False) -> sell_compliance_models.PagedComplianceViolationCollection
get_listing_violations(*, x_ebay_c_marketplace_id: str | None = None, compliance_type: str | None = None, offset: int | str | None = None, listing_id: str | None = None, limit: int | str | None = None, filter: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_listing_violations(*, x_ebay_c_marketplace_id: str | None = None, compliance_type: str | None = None, offset: int | str | None = None, listing_id: str | None = None, limit: int | str | None = None, filter: str | None = None, raw_response: bool = False) -> sell_compliance_models.PagedComplianceViolationCollection | httpx.Response
This call returns specific listing violations for the supported listing compliance types. Only one compliance type can be passed in per call, and the response will include all the listing violations for this compliance type, and listing violations are grouped together by eBay listing ID. See ComplianceTypeEnum for more information on the supported listing compliance types.
suppress_violation ¶
suppress_violation(*, body: SuppressViolationRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
suppress_violation(*, body: SuppressViolationRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
suppress_violation(*, body: SuppressViolationRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response
This call suppresses a listing violation for a specific listing. Only listing violations in the AT_RISK state (returned in the violations.complianceState field of the getListingViolations call) can be suppressed. Note: At this time, the suppressViolation call only supports the suppressing of ASPECTS_ADOPTION listing violations in the AT_RISK state.
Models¶
AspectRecommendations ¶
Bases: EbayModel
localized_aspect_name
class-attribute
instance-attribute
¶
localized_aspect_name = Field(None, alias='localizedAspectName', description='The name of the item aspect for which eBay has a recommendation. In many cases, the same item aspect(s) that are returned under the violationData array for ASPECTS_ADOPTION listing violations are also returned here Note: This name is always localized for the specified marketplace.')
suggested_values
class-attribute
instance-attribute
¶
suggested_values = Field(None, alias='suggestedValues', description='One or more valid values for the corresponding item aspect (in localizedAspectName) are returned here. These suggested values for the item aspect depend on the listing category and on the information specified in the listing. Sellers should confirm accuracy of the values before applying them to the listing.')
ComplianceSummaryInfo ¶
Bases: EbayModel
compliance_type
class-attribute
instance-attribute
¶
compliance_type = Field(None, alias='complianceType', description='This enumeration value indicates the type of compliance. See ComplianceTypeEnum for more information on each compliance type. For implementation help, refer to eBay API documentation')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='This enumeration value indicates the eBay marketplace where the listing violations exist. For implementation help, refer to eBay API documentation')
listing_count
class-attribute
instance-attribute
¶
listing_count = Field(None, alias='listingCount', description='This integer value indicates the number of eBay listings that are currently violating the compliance type indicated in the complianceType field, for the eBay marketplace indicated in the marketplaceId field.')
ErrorParameter ¶
NameValueList ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='This is the name of the variation aspect, or the name of the category of information that is returned through the name-value pair. The type of information that appears here will vary based on the compliance type and type of violation.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='This is the value of the variation aspect (in name field), or the value of the category of information that is returned through the name-value pair. The type of information that appears here will vary based on the compliance type and type of violation.')
ProductRecommendation ¶
Bases: EbayModel
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='This field will return the eBay Product ID {ePID) of an eBay Catalog product that eBay recommends that the seller use to make their listing compliant. Note: Product Adoption is not enforced at this time. Product Adoption violations are no longer returned.')
SuppressViolationRequest ¶
Bases: EbayModel
compliance_type
class-attribute
instance-attribute
¶
compliance_type = Field(None, alias='complianceType', description='The compliance type of the listing violation to suppress is specified in this field. The compliance type for each listing violation is found in the complianceType field under the listingViolations array in a getListingViolations response.')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the listing with the violation(s) is specified in this field. The unique identifier of the listing with the listing violation(s) is found in the listingId field under the listingViolations array in a getListingViolations response.')
VariationDetails ¶
Bases: EbayModel
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='The seller-defined SKU value of the variation within the multiple-variation listing with the violation{s). This field is only returned if a seller-defined SKU value is defined for the variation. SKU values are optional in listing except when creating listings using the Inventory API.')
variation_aspects
class-attribute
instance-attribute
¶
variation_aspects = Field(None, alias='variationAspects', description='An array of one or more variation aspects that define a variation within a multiple-variation listing. The aspect{s) returned here define the individual variation, because these aspects will differ for each variation. Common varying aspects include color and size.')
ComplianceSummary ¶
Bases: EbayModel
violation_summaries
class-attribute
instance-attribute
¶
violation_summaries = Field(None, alias='violationSummaries', description='This container is an array of one or more policy violation counts. A policy violation count is returned for each unique eBay marketplace and compliance type violation. As long as there is at least one non-compliant listing for the specified compliance type(s), this container will be returned.')
CorrectiveRecommendations ¶
Bases: EbayModel
product_recommendation
class-attribute
instance-attribute
¶
product_recommendation = Field(None, alias='productRecommendation', description='This container is only applicable (and possibly returned) for the PRODUCT_ADOPTION and PRODUCT_ADOPTION_CONFORMANCE compliance types, and since eBay catalog product adoption is not enforced for any eBay category at this time, the productRecommendation container will not be returned at this time.')
aspect_recommendations
class-attribute
instance-attribute
¶
aspect_recommendations = Field(None, alias='aspectRecommendations', description="This container is returned for ASPECTS_ADOPTION violations if eBay has found one or more item aspect name-value pairs that may be appropriate for the seller's product. In many cases, the missing or invalid item aspect(s) shown under the corresponding violationData array, will also show up under this array with suggested value(s).")
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
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.')
ComplianceDetail ¶
Bases: EbayModel
reason_code
class-attribute
instance-attribute
¶
reason_code = Field(None, alias='reasonCode', description='This value states the nature of the listing violation. A reasonCode value is returned for each listing violation, and each compliance type can have several reason codes and related messages. The reasonCode values vary by compliance type. The reason codes for each compliance type are summarized below.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='This field provides a textual summary of the listing violation. A message field is returned for each listing violation. This message will vary widely based on the compliance type and corresponding reason code.')
variation
class-attribute
instance-attribute
¶
variation = Field(None, description='This container defines the variation within a multiple-variation listing that has the listing violation. This container is only returned if an individual variation within a multiple-variation listing has the listing violation.')
violation_data
class-attribute
instance-attribute
¶
violation_data = Field(None, alias='violationData', description='This container provides more information about the listing violation, if applicable. The type of information that appears here will vary based on the compliance type and type of violation. For example, for ASPECTS_ADOPTION violations, this container lists the missing aspect(s) or aspect(s) with invalid values.')
corrective_recommendations
class-attribute
instance-attribute
¶
corrective_recommendations = Field(None, alias='correctiveRecommendations', description="This container is returned for ASPECTS_ADOPTION violations if eBay has found one or more item aspect name-value pairs that may be appropriate for the seller's product. In many cases, the missing or incorrect item aspect(s) shown under the corresponding violationData array, will also show up under the aspectRecommendations array with suggested value(s).")
compliance_state
class-attribute
instance-attribute
¶
compliance_state = Field(None, alias='complianceState', description='The enumeration value returned in this field indicates if the listing violation is considered to be OUT_OF_COMPLIANCE with an eBay listing policy, or the listing is considered to be AT_RISK of becoming non-compliant against an eBay listing policy. Generally, OUT_OF_COMPLIANCE policy violations can prevent the seller from revising a listing until the underlying violation(s) can be remedied.')
ComplianceViolation ¶
Bases: EbayModel
compliance_type
class-attribute
instance-attribute
¶
compliance_type = Field(None, alias='complianceType', description='This enumeration value indicates the compliance type of listing violation. See ComplianceTypeEnum for more information on each compliance type. This will always be returned for each listing violation that is found. For implementation help, refer to eBay API documentation')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the eBay listing that currently has the corresponding listing violation{s). This field will always be returned for each listing that has one or more violations.')
sku
class-attribute
instance-attribute
¶
sku = Field(None, description='The seller-defined SKU value of the product in the listing with the violation{s). This field is only returned if defined in the listing. SKU values are optional in listings except when creating listings using the Inventory API model.')
offer_id
class-attribute
instance-attribute
¶
offer_id = Field(None, alias='offerId', description='Note: This field is for future use, and will not be returned, even for listings created through the Inventory API. The unique identifier of the offer. This field is only applicable and returned for listings that were created through the Inventory API. To convert an Inventory Item object into an eBay listing, an Offer object must be created and published.')
violations
class-attribute
instance-attribute
¶
violations = Field(None, description='This container consists of an array of one or more listing violations applicable to the eBay listing specified in the listingId field. This array is returned for each eBay listing that has one or more violations. For each returned violation, the fields that are returned and the details that are given will depend on the listing violation.')
PagedComplianceViolationCollection ¶
Bases: EbayModel
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This integer value shows the offset of the current page of results. The offset value controls the first listing violation in the result set that will be displayed at the top of the response. The offset and limit query parameters are used to control the pagination of the output.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the getListingViolations call request that produced the current page of the result set.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of listing violations in the result set. If this value is higher than the limit value, there are multiple pages in the result set to view.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The getListingViolations call URI to use to view the next page of the result set. For example, the following URI returns listing violations 21 thru 30 from the collection of policy violations: path/listing_violation?limit=10&offset=20 This field is only returned if an additional page of listing violations exists.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The getListingViolations call URI to use to view the previous page of the result set. For example, the following URI returns listing violations 1 thru 10 from the collection of policy violations: path/listing_violation?limit=10&offset=0 This field is only returned if an previous page of listing violations exists.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The maximum number of listing violations returned per page of the result set. The limit and offset query parameters are used to control the pagination of the output. Note: If this is the last or only page in the result set, it may contain fewer listing violations than the limit value.')
listing_violations
class-attribute
instance-attribute
¶
listing_violations = Field(None, alias='listingViolations', description='An array of listing violations that match the criteria in the call request, including pagination control {if set). As long as there is at least one listing violation that matches the input criteria, this container will be returned. If no listing violations are found for the seller, an HTTP status code of 204 No Content is returned, and there is no response body.')