ComplianceDetail

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ComplianceDetail",
  "title": "ComplianceDetail",
  "type": "object",
  "properties": {
    "reasonCode": {
      "type": "string",
      "description": "This value states the nature of the listing violation. A <strong>reasonCode</strong> value is returned for each listing violation, and each compliance type can have several reason codes and related messages. The <strong>reasonCode</strong> values vary by compliance type. The reason codes for each compliance type are summarized below.<br /><br /><strong>Aspects adoption</strong><br /><br />The reason codes for <code>ASPECTS_ADOPTION</code> compliance indicate that for the given violation, aspects listed in the <strong>violationData</strong> container are either missing from the listing or they have invalid values. The reason codes specify whether the violation is for required aspects, recommended (preferred) aspects, or soon to be required aspects.<br /><ul><li><code>MISSING_OR_INVALID_REQUIRED_ASPECTS</code></li><li><code>MISSING_OR_INVALID_PREFERRED_ASPECTS</code></li><li><code>MISSING_OR_INVALID_SOON_TO_BE_REQUIRED_ASPECTS</code></li></ul><br /><strong>HTTPS</strong><br /><br />The reason codes for <code>HTTPS</code> compliance identify where in the listing the violation occurs. For HTTPS policy violations, the seller will just need to remove the HTTP link (or update to HTTPS) from the listing details or product details:<br /><ul><li><code>NON_SECURE_HTTP_LINK_IN_LISTING</code></li><li><code>NON_SECURE_HTTP_LINK_IN_PRODUCT</code></li></ul><br/><strong>Non-eBay links</strong><br /><br />The reason codes for <code>OUTSIDE_EBAY_BUYING_AND_SELLING</code> compliance identify the specific type of data (e.g., telephone number) that violated the policy. For each of these violations, the seller will just need to revise the listing, removing this information:<br /><ul><li><code>UNAPPROVED_DOMAIN_WEBLINK_IN_LISTING</code></li><li><code>PHONE_NUMBER_IN_LISTING</code></li><li><code>EMAIL_ADDRESS_IN_LISTING</code></li></ul><br /><strong>Product adoption</strong><br /><br />Product Adoption is not enforced at this time.<br /><br /><strong>Product adoption conformance</strong><br /><br />Product Adoption is not enforced at this time.<br /><br /><strong>Returns policy</strong><br /><br />The only <code>RETURNS_POLICY</code> reason code is <code>UNSUPPORTED_RETURNS_PERIOD</code>. The seller will have to revise their listing (or return business policy) with a supported return period for the site and category. The <strong>GetCategoryFeatures</strong> call of the Trading API can be used to verify the supported return periods for a particular category. For most eBay categories, the minimum return period that can be stated in a Returns Policy is 14 days for domestic and international sales, but some categories require a minimum 30-day return period."
    },
    "message": {
      "type": "string",
      "description": "This field provides a textual summary of the listing violation. A <strong>message</strong> field is returned for each listing violation. This message will vary widely based on the compliance type and corresponding reason code."
    },
    "variation": {
      "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.",
      "$ref": "#/components/schemas/VariationDetails"
    },
    "violationData": {
      "type": "array",
      "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 <code>ASPECTS_ADOPTION</code> violations, this container lists the missing aspect(s) or aspect(s) with invalid values.",
      "items": {
        "$ref": "#/components/schemas/NameValueList"
      }
    },
    "correctiveRecommendations": {
      "description": "This container is returned for <code>ASPECTS_ADOPTION</code> 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 <strong>violationData</strong> array, will also show up under the <strong>aspectRecommendations</strong> array with suggested value(s). <br><br><span class=\"tablenote\"><strong>Note:</strong> eBay catalog product adoption is not enforced for any eBay category at this time, so a recommended eBay product ID (aka ePID) will not be returned under the <strong>productRecommendation</strong> container at this time.</span>",
      "$ref": "#/components/schemas/CorrectiveRecommendations"
    },
    "complianceState": {
      "type": "string",
      "description": "The enumeration value returned in this field indicates if the listing violation is considered to be <code>OUT_OF_COMPLIANCE</code> with an eBay listing policy, or the listing is considered to be <code>AT_RISK</code> of becoming non-compliant against an eBay listing policy. <br><br>Generally, <code>OUT_OF_COMPLIANCE</code> policy violations can prevent the seller from revising a listing until the underlying violation(s) can be remedied. When the compliance state is <code>AT_RISK</code>, the seller is not blocked from revising the listing, but the seller should correct the violation to prevent the listing from being blocked for revisions in the future.<br><br><span class=\"tablenote\"><strong>Note:</strong> This field is returned for most violations, but not all. In the case that this field is not returned, it can be assumed that the state of the listing violation is <code>OUT_OF_COMPLIANCE</code>.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/compliance/types/com:ComplianceStateEnum'>eBay API documentation</a>"
    }
  },
  "description": "This type is used by each listing violation that is returned under the <strong>violations</strong> container."
}