Parameter | Type | Description |
---|---|---|
limit | integer | This query parameter is used if the user wants to set a limit on the number of listing violations that are returned in the current result set. This parameter is used in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10 , the call retrieves listing violations 11 thru 20 from the collection of listing violations that match the value set in the compliance_type parameter.Note: This feature employs a zero-based list, where the first item in the list has an offset of 0 . If the listing_id parameter is included in the request, this parameter will be ignored.Default: 100 Maximum: 200 Occurrence: Optional |
listing_id | string | Note: This query parameter is not yet supported for the Compliance API. Please not that until this query parameter becomes available, the compliance_type query parameter is required with each getListingViolations call. This query parameter is used if the user wants to view all listing violations for one or more eBay listings. The string value passed into this field is the unique identifier of the listing, sometimes referred to as the Item ID. Either the listing_id or a compliance_type query parameter must be used, and if the seller only wants to view listing violations of a specific compliance type, both of these parameters can be used. Up to 50 listing IDs can be specified with this query parameter, and each unique listing ID is separated with a comma. Occurrence: Conditional |
offset | integer | The first policy violation to return based on its position in the collection of listing violations. Use this parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10 , the call retrieves listing violations 11 thru 20 from the resulting collection of listing violations. Note: This feature employs a zero-based list, where the first item in the list has an offset of 0 . If the listing_id parameter is included in the request, this parameter will be ignored.Default: 0 {zero) Occurrence: Optional |
compliance_type | string | A seller uses this query parameter to retrieve listing violations of a specific compliance type. Only one compliance type value should be passed in here. See ComplianceTypeEnum for more information on the compliance types that can be passed in here. If the listing_id query parameter is used, the compliance_type query parameter {if passed in) will be ignored. This is because all of a listing's policy violations {each compliance type) will be returned if a listing_id is provided. Either the listing_id or a compliance_type query parameter must be used, and if the seller only wants to view listing violations of a specific compliance type, both of these parameters can be used. Note: The listing_id query parameter is not yet available for use, so the seller does not have the ability to retrieve listing violations for one or more specific listings. Until the listing_id query parameter becomes available, the compliance_type query parameter is required with each getListingViolations call. Occurrence: Conditional |
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 | 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.2.0 of the Compliance API is only supported on the US, UK, Australia, Canada {English), and Germany sites. Occurrence: Required |
This request requires an access token created with the authorization code grant flow, using one scope from the following list:
https://api.ebay.com/oauth/api_scope/sell.inventory
See OAuth access tokens for more information.
Output container/field | Type | Description |
---|---|---|
offset | integer | The distance {number of records) from the first policy violation in the collection to the first policy violation in this result set. In the call request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 30 and limit is set to 10 , the call retrieves policy violations 31 thru 40 from the resulting collection of policy violations. Note: This feature employs a zero-based list, where the first item in the list has an offset of 0 .Default: 0 {zero) Occurrence: Conditional |
href | string | The URI of the getListingViolations call request that produced the current page of the result set. Occurrence: Conditional |
total | integer | The total number of policy violations in the result set. Note: If no policy violations are found, this field is returned with a value of 0 . Occurrence: Conditional |
next | string | The getListingViolations call URI to use to view the next page of the result set. For example, the following URI returns policy violations 41 thru 50 from the collection of policy violations: path/listing_violation?limit=10&offset=40 This field is only returned if an additional page of listing violations exists. Occurrence: Conditional |
prev | string | The getListingViolations call URI to use to view the previous page of the result set. For example, the following URI returns policy violations 21 thru 30 from the collection of policy violations: path/listing_violation?limit=10&offset=20 Note: This feature employs a zero-based list, where the first policy violation in the list has an offset of 0 .This field is only returned if a previous page of listing violations exists. Occurrence: Conditional |
limit | integer | The maximum number of policy violations returned per page of the result set. Note: If this is the last or only result set in the collection, it may contain fewer listing violations than the limit value. To determine the number of pages in the result set, divide this value into the value of total and round up to the next integer. Default: 50 Max: 200 Occurrence: Conditional |
listingViolations | array of ComplianceViolation | An array of listing violations that match the criteria in the call request, including pagination control {if set). As long as there is at least one violation for the specified compliance type, this container will be returned. If no listing violations are found for the seller, an HTTP status code of 204 No Content is returned, and there is no response body. Occurrence: Conditional |
listingViolations.complianceType | ComplianceTypeEnum | This enumeration value indicates the compliance type of listing violation. See ComplianceTypeEnum for more information on each compliance type. This will always be returned for each listing violation that is found. Occurrence: Conditional |
listingViolations.listingId | string | The unique identifier of the eBay listing that currently has the corresponding listing violation{s). This will always be returned for each listing that has one or more violations. Occurrence: Conditional |
listingViolations.sku | string | The seller-defined SKU value of the product in the listing with the violation{s). This field is only returned if defined in the listing. SKU values are optional in listings except when creating listings using the Inventory API model. Occurrence: Conditional |
listingViolations.offerId | string | Note: This field is for future use, and will not be returned, even for listings created through the Inventory API. The unique identifier of the offer. This field is only applicable and returned for listings that were created through the Inventory API. To convert an Inventory Item object into an eBay listing, an Offer object must be created and published. Occurrence: Conditional |
listingViolations.violations | array of ComplianceDetail | This container consists of an array of one or more listing violations applicable to the eBay listing specified in the listingId field. This array is returned for each eBay listing that has one or more violations. Occurrence: Conditional |
listingViolations.violations.reasonCode | string | This value states the nature of the listing violation. A reasonCode value is returned for each listing violation, and each compliance type can have several reason codes and related messages. The reason codes for each compliance type are summarized below. The PRODUCT_ADOPTION reason codes and how to revise your listings based on these reason codes are summarized in the Using Compliance API reason codes to revise listings topic in the Product-Based Shopping Experience Playbook.The OUTSIDE_EBAY_BUYING_AND_SELLING reason codes include the following. For each of these violations, the seller will just need to remove this information with a revise listing call:
The HTTPS reason codes include the following. For each of these violations, the seller will just need to remove the HTTP link (or update to HTTPS) from the listing details or product details:
The PRODUCT_ADOPTION_CONFORMANCE reason codes include the following:
The only RETURNS_POLICY reason code is UNSUPPORTED_RETURNS_PERIOD . The seller will have to revise their listing (or return business policy) with a supported return period for the site and category. Occurrence: Conditional |
listingViolations.violations.message | string | This field provides a textual summary of the listing violation. A message field is returned for each listing violation. This message will vary widely based on the compliance type and corresponding reason code. Occurrence: Conditional |
listingViolations.violations.variation | VariationDetails | This container defines the variation within a multiple-variation listing that has the listing violation. This container is only returned if an individual variation within a multiple-variation listing has the listing violation. Occurrence: Conditional |
listingViolations.violations.variation.sku | string | The seller-defined SKU value of the variation within the multiple-variation listing with the violation{s). This field is only returned if a seller-defined SKU value is defined for the variation. SKU values are optional in listing except when creating listings using the Inventory API. Occurrence: Conditional |
listingViolations.violations.variation.variationAspects | array of NameValueList | An array of one or more variation aspects that define a variation within a multiple variation listing. The aspect{s) returned here define the individual variation because these aspects will differ for each variation. Common varying aspects include color and size. Occurrence: Conditional |
listingViolations.violations.variation.variationAspects.name | string | This is the name of the variation aspect, or the name of the category of information that is returned through the name-value pair. The type of information that appears here will vary based on the compliance type and type of violation. Occurrence: Conditional |
listingViolations.violations.variation.variationAspects.value | string | This is the value of the variation aspect (in name field), or the value of the category of information that is returned through the name-value pair. The type of information that appears here will vary based on the compliance type and type of violation. Occurrence: Conditional |
listingViolations.violations.violationData | array of NameValueList | Note: This container is for future use. Once it becomes available, this container will provide more information about the listing violation if applicable. The type of information that appears here will vary based on the compliance type and type of violation. Occurrence: Conditional |
listingViolations.violations.violationData.name | string | This is the name of the variation aspect, or the name of the category of information that is returned through the name-value pair. The type of information that appears here will vary based on the compliance type and type of violation. Occurrence: Conditional |
listingViolations.violations.violationData.value | string | This is the value of the variation aspect (in name field), or the value of the category of information that is returned through the name-value pair. The type of information that appears here will vary based on the compliance type and type of violation. Occurrence: Conditional |
listingViolations.violations.correctiveRecommendations | CorrectiveRecommendations | This container is returned if eBay has found an eBay Catalog product that may be a match for the product (or product variation) that has a listing violation. Note: As of August 2018, this container is only returned for the following Product-Based Shopping Experience categories: Smart Speakers (Cat. ID 184435), Audio Docks & Mini Speakers (Cat. ID 111694), Internet TV & Media Streamers (Cat. ID 168058), Space Heaters (Cat. ID 20613), Air Purifiers (Cat. ID 43510), Humidifiers (Cat. ID 71240), Portable Fans (Cat. ID 20612), and Programmable Thermostats (Cat. ID 115949). Occurrence: Conditional |
listingViolations.violations.correctiveRecommendations.productRecommendation | ProductRecommendation | This container is returned if eBay has found an eBay Catalog product that may be a match for the product (or product variation) that has a listing violation. Note: As of August 2018, this container is only returned for the following Product-Based Shopping Experience categories: Smart Speakers (Cat. ID 184435), Audio Docks & Mini Speakers (Cat. ID 111694), Internet TV & Media Streamers (Cat. ID 168058), Space Heaters (Cat. ID 20613), Air Purifiers (Cat. ID 43510), Humidifiers (Cat. ID 71240), Portable Fans (Cat. ID 20612), and Programmable Thermostats (Cat. ID 115949). Occurrence: Conditional |
listingViolations.violations.correctiveRecommendations.productRecommendation.epid | string | This field will return the eBay Product ID {ePID) of an eBay Catalog product that eBay recommends that the seller use to make their listing compliant. See the Product-Based Shopping Experience Playbook for more details on passing in an ePID for single and multiple-variation listings using the Inventory or Trading APIs. Note: As of August 2018, this container is only returned for the following Product-Based Shopping Experience categories: Smart Speakers (Cat. ID 184435), Audio Docks & Mini Speakers (Cat. ID 111694), Internet TV & Media Streamers (Cat. ID 168058), Space Heaters (Cat. ID 20613), Air Purifiers (Cat. ID 43510), Humidifiers (Cat. ID 71240), Portable Fans (Cat. ID 20612), and Programmable Thermostats (Cat. ID 115949). Occurrence: Conditional |
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 |
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 |
850102 | API_COMPLIANCE | REQUEST | Marketplace ID is missing |
850109 | API_COMPLIANCE | REQUEST | Single compliance type is supported per API call |
850110 | API_COMPLIANCE | REQUEST | Compliance type is invalid |
850111 | API_COMPLIANCE | REQUEST | Compliance type is missing |
850112 | API_COMPLIANCE | REQUEST | Invalid listing_id specified - {listingId} |
850113 | API_COMPLIANCE | REQUEST | listing_id not specified |
850114 | API_COMPLIANCE | REQUEST | Mandatory headers are missing |
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.
compliance_type
query parameter, and sets the value of the parameter to PRODUCT_ADOPTION
.
compliance_type
query parameter, and sets the value of the parameter to HTTPS
.
compliance_type
query parameter, and sets the value of the parameter to OUTSIDE_EBAY_BUYING_AND_SELLING
.
compliance_type
query parameter, and sets the value of the parameter to RETURNS_POLICY
. In this particular sample, the seller wants to limit the number of violations returned per page of data to five, starting with the first violation in the results set. To enable this, the seller includes the offset query parameter and sets its value to 0
, and includes the limit query parameter and sets its value to 5
compliance_type
query parameter, and sets the value of the parameter to PRODUCT_ADOPTION_CONFORMANCE
.