eBay · Schema

ComplianceViolation

This type is used by each listing violation that is returned under the listingViolations container.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
complianceType string This enumeration value indicates the compliance type of listing violation. See ComplianceTypeEnum for more information on each comp
listingId string 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 string 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 listin
offerId string Note: This field is for future use, and will not be returned, even for listings created through the Inventory API.

The unique identifier of
violations array 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 tha
View JSON Schema on GitHub

JSON Schema

ebay-complianceviolation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ComplianceViolation",
  "title": "ComplianceViolation",
  "type": "object",
  "properties": {
    "complianceType": {
      "type": "string",
      "description": "This enumeration value indicates the compliance type of listing violation. See <a href=\"/api-docs/sell/compliance/types/com:ComplianceTypeEnum\">ComplianceTypeEnum</a> for more information on each compliance type. This will always be returned for each listing violation that is found. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/compliance/types/com:ComplianceTypeEnum'>eBay API documentation</a>"
    },
    "listingId": {
      "type": "string",
      "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": {
      "type": "string",
      "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."
    },
    "offerId": {
      "type": "string",
      "description": "<span class=\"tablenote\"><strong>Note:</strong> This field is for future use, and will not be returned, even for listings created through the Inventory API.</span><br /><br /> 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": {
      "type": "array",
      "description": "This container consists of an array of one or more listing violations applicable to the eBay listing specified in the <strong>listingId</strong> field. This array is returned for each eBay listing that has one or more violations.<br><br>For each returned violation, the fields that are returned and the details that are given will depend on the listing violation.",
      "items": {
        "$ref": "#/components/schemas/ComplianceDetail"
      }
    }
  },
  "description": "This type is used by each listing violation that is returned under the <strong>listingViolations</strong> container."
}