Skip to main content

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.

Input

Resource URI

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

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

ParameterTypeDescription
compliance_typestringThis query parameter specifies the compliance type(s) of the listing violation counts being retrieved.

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.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThis header identifies the seller's eBay marketplace.

Supported values for this header can be found in the MarketplaceIdEnum type definition.

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

Response fields

Output container/fieldTypeDescription
violationSummariesarray 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.complianceTypeComplianceTypeEnum

This enumeration value indicates the type of compliance. See ComplianceTypeEnum for more information on each compliance type.

Occurrence: Conditional

violationSummaries.marketplaceIdMarketplaceIdEnum

This enumeration value indicates the eBay marketplace where the listing violations exist.

Occurrence: Conditional

violationSummaries.listingCountinteger

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.

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

Error codes

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

CodeDomainCategoryMeaning
850001API_COMPLIANCEAPPLICATIONAny System error. {additionalInfo}
850101API_COMPLIANCEREQUESTMarketplace ID is invalid
850110API_COMPLIANCEREQUESTCompliance type is invalid
850111API_COMPLIANCEREQUESTCompliance type is missing
850114API_COMPLIANCEREQUESTMandatory headers are missing

Warnings

This call has no warnings.

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.

GEThttps://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.

Got thoughts? Click the feedback button – your insights help us improve!