Just getting started with the Compliance API? See the following documents for details on using this API:
- Using eBay RESTful APIs
- Selling Integration Guide
- Compliance API overview
Requirements and restrictions - Compliance API Reference
The API release history
The following table lists the releases for the Compliance API:
Release Version |
Release Date |
Description of Release |
---|---|---|
2024-01-30 |
Decommissioned the suppressViolation method. |
|
2023-10-17 |
Deprecated the suppressViolation method. |
|
2020-08-17 |
Added a new |
|
2019-11-18 |
Added method to suppress |
|
2019-09-17 |
Enabled |
|
2018-11-08 |
Enabled |
|
2018-05-24 |
Canned Response in Sandbox for the |
|
2018-05-02 |
Enabled |
|
2018-03-15 |
Initial API release |
Version 1.4.3
The suppressViolation method has been decommissioned. All references to this method have been removed from the document set.
Version 1.4.2
The suppressViolation method has been deprecated and is no longer supported on any eBay marketplace. This method will be decommissioned on January 30th, 2024.
Version 1.4.1
The MISSING_OR_INVALID_SOON_TO_BE_REQUIRED_ASPECTS
type was added to the ASPECTS_ADOPTION
violations in the getListingViolations method response to indicate listing violations for aspects that are soon to be required.
Version 1.4.0
Added the suppressViolation method to suppress ASPECTS_ADOPTION
violations in the AT_RISK
state, and added a complianceState filter in getListingViolations method to retrieve ASPECTS_ADOPTION
violations in the AT_RISK
state.
Version 1.3.0
The ASPECTS_ADOPTION
compliance type lets you check listings for missing aspects (item specifics) or aspects with invalid values. The ASPECTS_ADOPTION
compliance type is supported in the eBay sandbox at the time of this release. Support for ASPECTS_ADOPTION
in production will come October 1, 2019.
Version 1.2.0
RETURNS_POLICY
and PRODUCT_ADOPTION_CONFORMANCE
compliance types enabled. The PRODUCT_ADOPTION_CONFORMANCE
compliance type is currently only enabled in Sandbox, but will be enabled in Production at a later date.
The RETURNS_POLICY
compliance type is used to see if any existing listings have unsupported return periods. Recently, many eBay sites (including US) deprecated the 14-day return period, so the minimum return period is now 30 days for many eBay sites.
The PRODUCT_ADOPTION_CONFORMANCE
compliance type is only applicable to listings associated with eBay catalog products. The types of listing violations related to this compliance type are summarized below:
PRODUCT_MISMATCH
: indicates that the product details in the listing and in the eBay catalog product do not match, and most likely means that the listing is associated with the wrong product.TITLE_MISMATCH
: indicates that the listing title and the product title in the eBay catalog product do not match, and either means that the catalog product title was overridden at listing time, or that the listing is associated with the wrong product.TITLE_OR_ITEMSPECIFICS_MISMATCH
: indicates that the listing title and/or Item Specifics in the listing do not match the product title and product aspects in the eBay catalog product.PRICE_OR_CONDITION_MISMATCH
: indicates that the item's price is not consistent with identical products based on the same eBay catalog product, and/or the item's condition is not consistent with supported item conditions in that category.
Version 1.1.0
Canned Response in Sandbox for the PRODUCT_ADOPTION
compliance type now returning recommended eBay Catalog products for non-compliant listings. Recommended catalog products are expected to start getting returned in the Production environment in July for non-compliant listings.
See the getListingViolations call reference documentation for more information about this new interface and to see the sample canned response.
Version 1.0.1
Below is a summary of the changes that were made for Version 1.0.1:
- The
OUTSIDE_EBAY_BUYING_AND_SELLING
compliance type was enabled in Production and Sandbox environments (only canned response returned in Sandbox). The seller can specify this compliance type in getListingViolationsSummary operation to get a total count of listings that are violating eBay's policy of including prohibited links to sites outside of eBay and/or including contact phone numbers or email addresses, and getListingViolations operation can be used to get specific data on these violations (if any). - The
HTTPS
compliance type was enabled in Production and Sandbox environments (only canned response returned in Sandbox). The seller can specify this compliance type in getListingViolationsSummary operation to get a total count of listings that are violating eBay's security requirement of using the 'HTTPS' protocol for all links (inside and outside of eBay), and this includes links to externally-hosted listing images, and getListingViolations operation can be used to get specific data on these violations (if any). - The
X-EBAY-C-MARKETPLACE-ID
request header is now optional instead of required when using getListingViolationsSummary operation. - Error codes 850102 and 850109 are no longer applicable to the getListingViolationsSummary operation, and have been removed from the list of error codes for that operation.
Version 1.0.0
This is the initial release of the Compliance API, Version 1.0.0
For a list of resources and methods, see the Compliance API Call Reference.