suppressViolation: eBay Compliance API | eBay Developers Program

POST/suppress_listing_violation

This call suppresses a listing violation for a specific listing. Only listing violations in the AT_RISK state (returned in the violations.complianceState field of the getListingViolations call) can be suppressed.

Note: At this time, the suppressViolation call only supports the suppressing of ASPECTS_ADOPTION listing violations in the AT_RISK state. In the future, it is possible that this method can be used to suppress other listing violation types.

A successful call returns a http status code of 204 Success. There is no response payload. If the call is not successful, an error code will be returned stating the issue.

Input

Resource URI

POST https://api.ebay.com/sell/compliance/v1/suppress_listing_violation

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

This method has no URI parameters.

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.

Header	Type	Description
Content-Type	string	This header indicates the format of the request body provided by the client. It's value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required
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.4.0 of the Compliance API is only supported on the US, UK, Australia, Canada {English), and Germany sites. Occurrence: Required

Header

Type

Description

Content-Type

string

This header indicates the format of the request body provided by the client. It's value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

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.4.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

Copy complete valid JSON to clipboard

{ /* SuppressViolationRequest */

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

"listingId" : "string"

}

Request fields

Input container/field Type Description

Input container/field	Type	Description
complianceType	ComplianceTypeEnum	The compliance type of the listing violation to suppress is specified in this field. The compliance type for each listing violation is found in the complianceType field under the listingViolations array in a getListingViolations response. Note: At this time, the suppressViolation method is only used to suppress aspect adoption listing violations in the 'at-risk' state, so `ASPECTS_ADOPTION` is currently the only supported value for this field. Occurrence:
listingId	string	The unique identifier of the listing with the violation(s) is specified in this field. The unique identifier of the listing with the listing violation(s) is found in the listingId field under the listingViolations array in a getListingViolations response. Note: At this time, the suppressViolation method is only used to suppress aspect adoption listing violations in the 'at-risk' state, so the listing specified in this field should be a listing with an `ASPECTS_ADOPTION` violation in the 'at-risk' state. Occurrence:

complianceType

ComplianceTypeEnum

The compliance type of the listing violation to suppress is specified in this field. The compliance type for each listing violation is found in the complianceType field under the listingViolations array in a getListingViolations response.

Note: At this time, the suppressViolation method is only used to suppress aspect adoption listing violations in the 'at-risk' state, so ASPECTS_ADOPTION is currently the only supported value for this field.

Occurrence:

listingId

string

The unique identifier of the listing with the violation(s) is specified in this field. The unique identifier of the listing with the listing violation(s) is found in the listingId field under the listingViolations array in a getListingViolations response.

Note: At this time, the suppressViolation method is only used to suppress aspect adoption listing violations in the 'at-risk' state, so the listing specified in this field should be a listing with an ASPECTS_ADOPTION violation in the 'at-risk' state.

Occurrence:

Output

HTTP response headers

This call has no response headers.

Response payload

This call has no payload.

Response fields

This call has no field definitions.

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
204	Success
400	Bad Request
409	Business error
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
850110	API_COMPLIANCE	REQUEST	Compliance type is invalid
850111	API_COMPLIANCE	REQUEST	Compliance type is missing
850112	API_COMPLIANCE	REQUEST	Invalid listing_id specified
850113	API_COMPLIANCE	REQUEST	listing_id not specified
850120	API_COMPLIANCE	REQUEST	Listing is already compliant. You can not suppress compliant listing
850121	API_COMPLIANCE	REQUEST	Listing has required aspects not filled. You can not suppress the violation when required aspects are missing
850122	API_COMPLIANCE	REQUEST	Violation is already suppressed on this listing

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: Suppress violation for a listing

This call suppresses a ASPECTS_ADOPTION listing violation (in the AT_RISK state) for a specific listing.

Input

In the request payload, the user passes in ASPECTS_ADOPTION as the complianceType, and identifies the listing through the listingId field.

POSThttps://api.ebay.com/sell/compliance/v1/suppress_listing_violation

Output

A successful call returns a http status code of 204 Success. There is no response payload.