compliance API1.1.0

Compliance API

The Compliance API is used to retrieve listing violations for three different compliance types. Once listing violations are discovered in active listings for the seller, it is up to the seller to make revisions to these listings to correct the listing violations. The three different listing compliance types are summarized below:

  • Product Adoption: this compliance type is used to see if any listings (or variations within multiple-variation listings) are violating eBay's new Product-Based Shopping Experience requirement. Beginning in mid-May 2018, some eBay categories and product brands will start requiring that sellers associate those listings with an eBay Catalog product. If a seller does not use a catalog product for categories/brands applicable to the Product-Based Shopping Experience requirement, a create or revise listing action will be blocked. For more information on Product-Based Shopping Experience, see the Product-Based Shopping Experience Playbook. The Product Adoption compliance type also applies to any listings (or variations within multiple-variation listings) that are missing required product identifiers (GTINs or Brand/MPN), and when variations within multiple-variation listings are wrongfully sharing the same GTIN/MPN values. In the API interface, the enumeration value for this compliance type is PRODUCT_ADOPTION.
  • HTTPS protocol: this compliance type is used to see if any listings are violating eBay's policy of using 'HTTP' links in the listing instead of 'HTTPS' links. This requirement includes links to externally-hosted listing images. If the server hosting the listing images does not support the HTTPS protocol, this server cannot be used to host listing images. In the API interface, the enumeration value for this compliance type is HTTPS.
  • Non-eBay Links or contact information: this compliance type is used to see if any listings are violating eBay's policy of not allowing links in the listing to sites outside of eBay. The seller including a personal email address and/or a phone number in the listing is also a violation of this policy. All communication between seller and buyers should be handled through eBay's communication system. The only exceptions to this outside links rule are links to product videos, information on freight shipping services, or any legally required information. In the API interface, the enumeration value for this compliance type is OUTSIDE_EBAY_BUYING_AND_SELLING.

The Compliance API has the following two calls:

  • getListingViolationsSummary: this call returns the number of active listings that are currently violating one or more compliance types. Results are grouped by each unique eBay marketplace and compliance type combination.
  • getListingViolations: this call returns data on each listing violation in the seller's active listings. Results are grouped by listing, so if one eBay listing has multiple listing violations for a specific compliance type, these violations will be shown together. Only one compliance type can be used per call.

Technical overview

The Compliance API is a REST-based API that retrieves listing violations for any eBay listings, regardless of which user interface, tool, or API was used to create those listings. For those who are new to using eBay RESTful APIs, it is recommended that you read the Using eBay RESTful APIs document, which summarizes eBay developer account requirements, OAuth access tokens, handling error messages, and more.

The getListingViolations call is enabled with pagination control. With pagination control, the user can set a limit of the number of listing violations returned per page of data, and can use an offset query parameter to scroll through multiple pages of results (if applicable).

Business use cases

Below are the high-level use cases addressed by the Compliance API.

  • Retrieve the number of active listings that have one or more listing violations.
  • Retrieve data on all listing violations. The retrieved data includes the unique identifier of the eBay listing (and unique identifier of variation, if applicable) and details on the listing violation. Once the seller has this information on listing violation(s), the seller can use the createOrReplaceInventoryItem call of the Inventory API or ReviseItem/ReviseFixedPriceItem call of the Trading API to revise these listings.
Note: In a future release of the Compliance API, with the activation of a listing_id query parameter, the getListingViolations call will support the ability to retrieve listing violation data for specified eBay listings.

API requirements

To use the Compliance API (or any other eBay public API), the user must have an eBay Developers Program account. If you already have an account, but have never used eBay RESTful APIs, there are additional requirements that are covered in the Using eBay RESTful APIs document.

API restrictions

Currently, the Compliance API is supported on the following four sites: US, UK, Australia, and Canada (English).

Currently, Compliance API calls that are run in the Sandbox environment will only returned canned responses, and will not actually be the seller's actual listing violation data.