compliance API1.3.0

getListingViolations

GET

/listing_violation

This call returns specific listing violations for five different 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 are grouped together by eBay listing ID. See ComplianceTypeEnum for more information on the five different compliance types. This method also has pagination control.

Note: A maximum of 2000 listing violations will be returned in a result set. If the seller has more than 2000 listing violations, some/all of those listing violations must be corrected before additional listing violations will be retrieved. The user should pay attention to the total value in the response. If this value is '2000', it is possible that the seller has more than 2000 listing violations, but this field maxes out at 2000.

Note: In a future release of this API, the seller will be able to pass in a specific eBay listing ID as a query parameter to see if this specific listing has any violations.

Note: Only a canned response for this call will be returned in the Sandbox environment, so the non-compliant listing data will not be specific to the seller.

Input

Resource URI (production)

GET https://api.ebay.com/sell/compliance/v1/listing_violation?

compliance_type=string&

offset=integer&

listing_id=string&

limit=integer

URI parameters

Parameter	Type	Description
compliance_type	string	A seller uses this query parameter to retrieve listing violations of a specific compliance type. Only one compliance type value should be passed in here. See ComplianceTypeEnum for more information on the compliance types that can be passed in here. If the listing_id query parameter is used, the compliance_type query parameter {if passed in) will be ignored. This is because all of a listing's policy violations {each compliance type) will be returned if a listing_id is provided. Either the listing_id or a compliance_type query parameter must be used, and if the seller only wants to view listing violations of a specific compliance type, both of these parameters can be used. Note: The listing_id query parameter is not yet available for use, so the seller does not have the ability to retrieve listing violations for one or more specific listings. Until the listing_id query parameter becomes available, the compliance_type query parameter is required with each getListingViolations call. Occurrence: Conditional
offset	integer	The first policy violation to return based on its position in the collection of listing violations. Use this parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to `10` and limit is set to `10`, the call retrieves listing violations 11 thru 20 from the resulting collection of listing violations. Note: This feature employs a zero-based list, where the first item in the list has an offset of `0`. If the listing_id parameter is included in the request, this parameter will be ignored. Default: `0` {zero) Occurrence: Optional
listing_id	string	Note: This query parameter is not yet supported for the Compliance API. Please not that until this query parameter becomes available, the compliance_type query parameter is required with each getListingViolations call. This query parameter is used if the user wants to view all listing violations for one or more eBay listings. The string value passed into this field is the unique identifier of the listing, sometimes referred to as the Item ID. Either the listing_id or a compliance_type query parameter must be used, and if the seller only wants to view listing violations of a specific compliance type, both of these parameters can be used. Up to 50 listing IDs can be specified with this query parameter, and each unique listing ID is separated with a comma. Occurrence: Conditional
limit	integer	This query parameter is used if the user wants to set a limit on the number of listing violations that are returned in the current result set. This parameter is used in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to `10` and limit is set to `10`, the call retrieves listing violations 11 thru 20 from the collection of listing violations that match the value set in the compliance_type parameter. Note: This feature employs a zero-based list, where the first item in the list has an offset of `0`. If the listing_id parameter is included in the request, this parameter will be ignored. Default: `100` Maximum: `200` Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

This method has the additional request header requirements listed below. See HTTP request headers - opens rest request components page for details.

Header	Type	Description
X-EBAY-C-MARKETPLACE-ID	string	This header is required and is used to specify the eBay marketplace identifier. Supported values for this header can be found in the MarketplaceIdEnum type definition. Note that Version 1.3.0 of the Compliance API is only supported on the US, UK, Australia, Canada {English), and Germany sites. Occurrence: Required

Header

Type

Description

X-EBAY-C-MARKETPLACE-ID

string

This header is required and is used to specify the eBay marketplace identifier. Supported values for this header can be found in the MarketplaceIdEnum type definition. Note that Version 1.3.0 of the Compliance API is only supported on the US, UK, Australia, Canada {English), and Germany sites.

Occurrence: Required

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.inventory

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to Clipboard

{ /* PagedComplianceViolationCollection */

"offset" : "integer",

"href" : "string",

"total" : "integer",

"next" : "string",

"prev" : "string",

"limit" : "integer",

"listingViolations" : [

{ /* ComplianceViolation */

"complianceType" : "ComplianceTypeEnum : [ASPECTS_ADOPTION,HTTPS,OUTSIDE_EBAY_BUYING_AND_SELLING...]",

"listingId" : "string",

"sku" : "string",

"offerId" : "string",

"violations" : [

{ /* ComplianceDetail */

"reasonCode" : "string",

"message" : "string",

"variation" :

{ /* VariationDetails */

"sku" : "string",

"variationAspects" : [

{ /* NameValueList */

"name" : "string",

"value" : "string"

}

]

"violationData" : [

{ /* NameValueList */

"name" : "string",

"value" : "string"

}

"correctiveRecommendations" :

{ /* CorrectiveRecommendations */

"productRecommendation" :

{ /* ProductRecommendation */

"epid" : "string"

"aspectRecommendations" : [

{ /* AspectRecommendations */

"localizedAspectName" : "string",

"suggestedValues" : [

"string"

]

}

]

"complianceState" : "ComplianceStateEnum : [OUT_OF_COMPLIANCE,AT_RISK]"

}

]

}

]

}

Response fields

Output container/field	Type	Description
offset	integer	The distance {number of records) from the first policy violation in the collection to the first policy violation in this result set. In the call request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to `30` and limit is set to `10`, the call retrieves policy violations 31 thru 40 from the resulting collection of policy violations. Note: This feature employs a zero-based list, where the first item in the list has an offset of `0`. Default: `0` {zero) Occurrence: Conditional
href	string	The URI of the getListingViolations call request that produced the current page of the result set. Occurrence: Conditional
total	integer	The total number of policy violations in the result set. Note: If no policy violations are found, this field is returned with a value of `0`. Occurrence: Conditional
next	string	The getListingViolations call URI to use to view the next page of the result set. For example, the following URI returns policy violations 41 thru 50 from the collection of policy violations: `path/listing_violation?limit=10&offset=40` This field is only returned if an additional page of listing violations exists. Occurrence: Conditional
prev	string	The getListingViolations call URI to use to view the previous page of the result set. For example, the following URI returns policy violations 21 thru 30 from the collection of policy violations: `path/listing_violation?limit=10&offset=20` Note: This feature employs a zero-based list, where the first policy violation in the list has an offset of `0`. This field is only returned if a previous page of listing violations exists. Occurrence: Conditional
limit	integer	The maximum number of policy violations returned per page of the result set. Note: If this is the last or only result set in the collection, it may contain fewer listing violations than the limit value. To determine the number of pages in the result set, divide this value into the value of total and round up to the next integer. Default: `50` Max: `200` Occurrence: Conditional
listingViolations	array of ComplianceViolation	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 violation for the specified compliance type, 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. Occurrence: Conditional
listingViolations.complianceType	ComplianceTypeEnum	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. Occurrence: Conditional
listingViolations.listingId	string	The unique identifier of the eBay listing that currently has the corresponding listing violation{s). This will always be returned for each listing that has one or more violations. Occurrence: Conditional
listingViolations.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 listings using the Inventory API model. Occurrence: Conditional
listingViolations.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 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. Occurrence: Conditional
listingViolations.violations	array of ComplianceDetail	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. Occurrence: Conditional
listingViolations.violations.reasonCode	string	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. Aspects adoption The `ASPECTS_ADOPTION` reason codes indicate that for the given violation, aspects listed in the violationData container are either missing from the listing or they have invalid values. The reason codes specify whether the violation is for required aspects or recommended (preferred) aspects. `MISSING_OR_INVALID_REQUIRED_ASPECTS` `MISSING_OR_INVALID_PREFERRED_ASPECTS` HTTPS The `HTTPS` reason codes 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: `NON_SECURE_HTTP_LINK_IN_LISTING` `NON_SECURE_HTTP_LINK_IN_PRODUCT` Non-eBay links The `OUTSIDE_EBAY_BUYING_AND_SELLING` reason codes 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 remove this information with a revise listing call: `UNAPPROVED_DOMAIN_WEBLINK_IN_LISTING` `PHONE_NUMBER_IN_LISTING` `EMAIL_ADDRESS_IN_LISTING` Product adoption Product Adoption is not enforced at this time. Product adoption conformance Product Adoption is not enforced at this time. Returns policy The only `RETURNS_POLICY` reason code is `UNSUPPORTED_RETURNS_PERIOD`. The seller will have to revise their listing (or return business policy) with a supported return period for the site and category. Occurrence: Conditional
listingViolations.violations.message	string	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. Occurrence: Conditional
listingViolations.violations.variation	VariationDetails	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. Occurrence: Conditional
listingViolations.violations.variation.sku	string	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. Occurrence: Conditional
listingViolations.violations.variation.variationAspects	array of NameValueList	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. Occurrence: Conditional
listingViolations.violations.variation.variationAspects.name	string	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. Occurrence: Conditional
listingViolations.violations.variation.variationAspects.value	string	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. Occurrence: Conditional
listingViolations.violations.violationData	array of NameValueList	This container providee 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 Aspect Adoption violations, this container lists the missing aspects or aspects with invalid values. Occurrence: Conditional
listingViolations.violations.violationData.name	string	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. Occurrence: Conditional
listingViolations.violations.violationData.value	string	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. Occurrence: Conditional
listingViolations.violations.correctiveRecommendations	CorrectiveRecommendations	This container is returned if eBay has found an eBay Catalog product that may be a match for the product (or product variation) that has a listing violation. Note: Product Adoption is not enforced at this time. Product Adoption violations are no longer returned. Occurrence: Conditional
listingViolations.violations.correctiveRecommendations.productRecommendation	ProductRecommendation	This container is returned if eBay has found an eBay Catalog product that may be a match for the product (or product variation) that has a listing violation. Note: Product Adoption is not enforced at this time. Product Adoption violations are no longer returned. Occurrence: Conditional
listingViolations.violations.correctiveRecommendations.productRecommendation.epid	string	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. Occurrence: Conditional
listingViolations.violations.correctiveRecommendations.aspectRecommendations	array of AspectRecommendations	When a listing has violations for ASPECTS_ADOPTION, the response includes recommendations for each aspect that has been identified as missing or invalid. Occurrence: Conditional
listingViolations.violations.correctiveRecommendations.aspectRecommendations.localizedAspectName	string	The localized name of this aspect (for example: `Colour` on the eBay UK site). Note: This name is always localized for the specified marketplace. Occurrence: Conditional
listingViolations.violations.correctiveRecommendations.aspectRecommendations.suggestedValues	array of string	One or more valid aspect values suggested for the given aspect, based on the category and information specified in the listing. Sellers should confirm accuracy of the values before applying them to the listing. Please use getItemAspectsForCategory in the Taxonomy API or GetCategorySpecifics in the Trading API to get a comprehensive list of required and recommended aspects for a given category and a list of supported aspect values for each. Occurrence: Conditional
listingViolations.violations.complianceState	ComplianceStateEnum	This property indicates the severity of the given policy violation for a listing. Generally, OUT_OF_COMPLIANCE policy violations can prevent the seller from revising a listing until the underlying violation(s) can be remedied. When the compliance state is AT_RISK, the seller is not blocked from revising the listing, but the seller should correct the violation to prevent the listing from bing blocked for revisions in the future. This field is not returned for all violations. The default value, when not returned, is OUT_OF_COMPLIANCE. Applicable values: OUT_OF_COMPLIANCE AT_RISK Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
200	Success
204	No Content
400	Bad Request
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
850001	API_COMPLIANCE	APPLICATION	Any System error. {additionalInfo}
850101	API_COMPLIANCE	REQUEST	Marketplace ID is invalid
850102	API_COMPLIANCE	REQUEST	Marketplace ID is missing
850109	API_COMPLIANCE	REQUEST	Single compliance type is supported per API call
850110	API_COMPLIANCE	REQUEST	Compliance type is invalid
850111	API_COMPLIANCE	REQUEST	Compliance type is missing
850112	API_COMPLIANCE	REQUEST	Invalid listing_id specified - {listingId}
850113	API_COMPLIANCE	REQUEST	listing_id not specified
850114	API_COMPLIANCE	REQUEST	Mandatory headers are missing

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get Aspects Adoption Violations

Sample 2: Get HTTP Violations

Sample 3: Get 'Outside eBay' Violations

Sample 4: Get 'Returns Policy' Violations

Sample 1: Get Aspects Adoption Violations

This seller wants to see which active listings are currently violating the aspects adoption requirement.

Input

In the call URI, the seller passes in the required compliance_type query parameter, and sets the value of the parameter to ASPECTS_ADOPTION.

GET

https://api.ebay.com/sell/compliance/v1/listing_violation?compliance_type=ASPECTS_ADOPTION&offset=0&limit=5

Output

The call response payload groups violations by listing ID. Each violation has reasonCode, message, and complianceState fields, which provides more information about the violation. The correctiveRecommendations.aspectRecommendations container is returned with suggested values for the aspects that are called out in the violation.

Based on the type of violation, the seller will have to revise these listings, using the createOrReplaceInventoryItem call of the Inventory API, or the ReviseItemReviseFixedPriceItem call of the Trading API.

{
  "total": 1,
  "listingViolations": [
    {
      "complianceType": "ASPECTS_ADOPTION",
      "listingId": "120013241299",
      "violations": [
        {
          "reasonCode": "MISSING_OR_INVALID_REQUIRED_ASPECTS",
          "message": "Provide required aspects",
          "complianceState": "OUT_OF_COMPLIANCE",
          "violationData": [
            {
              "name": "Aspect",
              "value": "UPC"
            },
            {
              "name": "Aspect",
              "value": "Brand"
            },
            {
              "name": "Aspect",
              "value": "MPN"
            }
          ],
          "correctiveRecommendations": {
            "aspectRecommendations": [
              {
                "localizedAspectName": "Brand",
                "suggestedValues": [
                  "Nest"
                ]
              }
            ]
          }
        },
        {
          "reasonCode": "MISSING_OR_INVALID_PREFERRED_ASPECTS",
          "message": "Provide preferred aspects",
          "complianceState": "AT_RISK",
          "violationData": [
            {
              "name": "Aspect",
              "value": "Model"
            },
            {
              "name": "Aspect",
              "value": "Smart Home Protocol"
            },
            {
              "name": "Aspect",
              "value": "Color"
            }
          ],
          "correctiveRecommendations": {
            "aspectRecommendations": [
              {
                "localizedAspectName": "Model",
                "suggestedValues": [
                  "Nest Learning Thermostat (3rd Generation)"
                ]
              },
              {
                "localizedAspectName": "Smart Home Protocol",
                "suggestedValues": [
                  "Wi-Fi"
                ]
              },
              {
                "localizedAspectName": "Color",
                "suggestedValues": [
                  "Black"
                ]
              }
            ]
          }
        }
      ]
    }
  ]
}

Sample 2: Get HTTP Violations

This seller wants to see which active listings are currently violating eBay's policy of having 'HTTP' links instead of 'HTTPS'.

Input

In the call URI, the seller passes in the required compliance_type query parameter, and sets the value of the parameter to HTTPS.

GET

https://api.ebay.com/sell/compliance/v1/listing_violation?compliance_type=HTTPS

Output

The call response payload groups violations by listing ID. Each violation has a reasonCode and a message field which provides more information about the violation.

The seller will have to revise these listings, removing or correcting all 'HTTP' links using the createOrReplaceInventoryItem call of the Inventory API, or the ReviseItemReviseFixedPriceItem call of the Trading API. Note that many webites/servers support both the 'HTTP' and 'HTTPS' protocols, so the seller may just need to update the link (from 'http' to 'https'), but it the referenced website/server does not support the 'HTTPS' protocol, that link will have to be removed from the listing. This includes links to externally-hosted images.

Sample 3: Get 'Outside eBay' Violations

This seller wants to see which active listings are currently violating eBay's policy against unauthorized external links or having contact information (phone number or email address) in the listing.

Input

In the call URI, the seller passes in the required compliance_type query parameter, and sets the value of the parameter to OUTSIDE_EBAY_BUYING_AND_SELLING.

GET

https://api.ebay.com/sell/compliance/v1/listing_violation?compliance_type=OUTSIDE_EBAY_BUYING_AND_SELLING

Output

{
  "total": 2,
  "listingViolations": [
    {
      "complianceType": "OUTSIDE_EBAY_BUYING_AND_SELLING",
      "listingId": "200008588400",
      "violations": [
        {
          "reasonCode": "UNAPPROVED_DOMAIN_WEBLINK_IN_LISTING",
          "message": "Remove contact info and/or links to non-eBay websites from listings"
        },
        {
          "reasonCode": "PHONE_NUMBER_IN_LISTING",
          "message": "Remove contact info and/or links to non-eBay websites from listings"
        }
      ]
    },
    {
      "complianceType": "OUTSIDE_EBAY_BUYING_AND_SELLING",
      "listingId": "200008588392",
      "violations": [
        {
          "reasonCode": "UNAPPROVED_DOMAIN_WEBLINK_IN_LISTING",
          "message": "Remove contact info and/or links to non-eBay websites from listings"
        },
        {
          "reasonCode": "PHONE_NUMBER_IN_LISTING",
          "message": "Remove contact info and/or links to non-eBay websites from listings"
        }
      ]
    }
  ],
  "limit": 10,
  "offset": 0
}

Sample 4: Get 'Returns Policy' Violations

This seller wants to see which active listings have return periods that are no longer supported for the site/category.

Input

In the call URI, the seller passes in the required compliance_type query parameter, and sets the value of the parameter to RETURNS_POLICY. In this particular sample, the seller wants to limit the number of violations returned per page of data to five, starting with the first violation in the results set. To enable this, the seller includes the offset query parameter and sets its value to 0, and includes the limit query parameter and sets its value to 5

GET

https://api.ebay.com/sell/compliance/v1/listing_violation?compliance_type=RETURNS_POLICY&offset=0&limit=5

Output

The call response payload groups violations by listing ID. Each violation has a reasonCode and a message field which provides more information about the violation.

The seller will have to revise these listings, updating the return period to a value that is supported for the site/category.

Note that only five listing violations are returned in the sample, but there are actual 10 listing violations of this compliance type. If the seller wanted to get the next page of data (and remaining five listing violations), he/she could just grab the call URI that is in the next field and run the operation again.

{
  "total": 10,
  "listingViolations": [
    {
      "complianceType": "RETURNS_POLICY",
      "listingId": "120011102802",
      "violations": [
        {
          "reasonCode": "UNSUPPORTED_RETURNS_PERIOD",
          "message": "You must select a return period which is supported"
        }
      ]
    },
    {
      "complianceType": "RETURNS_POLICY",
      "listingId": "120011102796",
      "violations": [
        {
          "reasonCode": "UNSUPPORTED_RETURNS_PERIOD",
          "message": "You must select a return period which is supported"
        }
      ]
    },
    {
      "complianceType": "RETURNS_POLICY",
      "listingId": "120011102797",
      "violations": [
        {
          "reasonCode": "UNSUPPORTED_RETURNS_PERIOD",
          "message": "You must select a return period which is supported"
        }
      ]
    },
    {
      "complianceType": "RETURNS_POLICY",
      "listingId": "120011102798",
      "violations": [
        {
          "reasonCode": "UNSUPPORTED_RETURNS_PERIOD",
          "message": "You must select a return period which is supported"
        }
      ]
    },
    {
      "complianceType": "RETURNS_POLICY",
      "listingId": "120011102799",
      "violations": [
        {
          "reasonCode": "UNSUPPORTED_RETURNS_PERIOD",
          "message": "You must select a return period which is supported"
        }
      ]
    }
  ],
  "next": "https://api.sandbox.ebay.com/sell/compliance/v1/listing_violation?limit=5&compliance_type=RETURNS_POLICY&offset=5",
  "limit": 5,
  "offset": 0
}