GET
/listing_violation_summary
This call returns listing violation counts for a seller. A user can pass in one or more compliance types through the compliance_type query parameter. See ComplianceTypeEnum for more information on the supported listing compliance types. Listing violations are returned for multiple marketplaces if the seller sells on multiple eBay marketplaces.
Note: Only a canned response, with counts for all listing compliance types, is returned in the Sandbox environment. Due to this limitation, the compliance_type query parameter (if used) will not have an effect on the response.
Note: Only a canned response, with counts for all listing compliance types, is returned in the Sandbox environment. Due to this limitation, the compliance_type query parameter (if used) will not have an effect on the response.
Input
Resource URI (production)
GET https://api.ebay.com/sell/compliance/v1/listing_violation_summary?
URI parameters
| Parameter | Type | Description |
|---|---|---|
| compliance_type | string | A user passes in one or more compliance type values through this query parameter. See ComplianceTypeEnum for more information on the supported compliance types that can be passed in here. If more than one compliance type value is used, delimit these values with a comma. If no compliance type values are passed in, the listing count for all compliance types will be returned. Note: Only a canned response, with counts for all listing compliance types, is returned in the Sandbox environment. Due to this limitation, the compliance_type query parameter (if used) will not have an effect on the response. 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 | Use this header to specify the eBay marketplace identifier. Supported values for this header can be found in the MarketplaceIdEnum type definition. Note that Version 1.4.0 of the Compliance API is only supported on the US, UK, Australia, Canada {English), and Germany sites. Occurrence: Strongly Recommended |
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.
Output
{ /* ComplianceSummary */
"violationSummaries" : [
}{ /* ComplianceSummaryInfo */
]"complianceType" : "ComplianceTypeEnum : [ASPECTS_ADOPTION,HTTPS,OUTSIDE_EBAY_BUYING_AND_SELLING...]",
}| Output container/field | Type | Description |
|---|---|---|
| violationSummaries | array of ComplianceSummaryInfo | This container is an array of one or more policy violation counts. A policy violation count is returned for each unique eBay marketplace and compliance type violation. As long as there is at least one non-compliant listing for the specified compliance type(s), this container will be returned. If no non-compliant listings are found for the specified compliance type(s), an HTTP status code of 204 No Content is returned, and there is no response body. Occurrence: Conditional |
| violationSummaries.complianceType | ComplianceTypeEnum | This enumeration value indicates the type of compliance. See ComplianceTypeEnum for more information on each compliance type. Occurrence: Conditional |
| violationSummaries.marketplaceId | MarketplaceIdEnum | This enumeration value indicates the eBay marketplace where the listing violations exist. Occurrence: Conditional |
| violationSummaries.listingCount | integer | This integer value indicates the number of eBay listings that are currently violating the compliance type indicated in the complianceType field, for the eBay marketplace indicated in the marketplaceId field. 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 |
| 850110 | API_COMPLIANCE | REQUEST | Compliance type is invalid |
| 850111 | API_COMPLIANCE | REQUEST | Compliance type is missing |
| 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 Listing Counts for All Compliance Types
This seller wants to get counts of active listings that are currently non-compliant with any of the five compliance types.
Input
In the call URI, since the seller wants to retrieve listing violation counts for all compliance types, he/she runs the operation without the
compliance_type query parameter.
GET
https://api.ebay.com/sell/compliance/v1/listing_violation_summary
Output
The call response payload includes listing violation counts for all compliance types. Since the seller sells on two eBay marketplaces (US and UK), individual counts for each of these markeplaces are separated out. Each returned node shows the compliance type, the marketplace, and the number of active listings currently violating the corresponding compliance type. The next step for the seller would be to start making getListingViolations calls to find the specific, non-compliant listings.