{"note":"OpenAPI conversion -- returning structured metadata","name":"ebay-com-sell-compliance","description":"Compliance API","version":"1.4.4","base_url":"https://api.ebay.com/sell/compliance/v1","endpoints":2,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Compliance API\n@base https://api.ebay.com/sell/compliance/v1\n@version 1.4.4\n@auth OAuth2\n@endpoints 2\n@toc listing_violation_summary(1), listing_violation(1)\n\n@group listing_violation_summary\n@endpoint GET /listing_violation_summary\n@desc 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.\n@required {X-EBAY-C-MARKETPLACE-ID: str # This header identifies the seller's eBay marketplace. Supported values for this header can be found in the MarketplaceIdEnum type definition.}\n@optional {compliance_type: str # Note: The ASPECTS_ADOPTION compliance type has been deprecated and will be decommissioned on September 9th, 2025.This 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.}\n@returns(200) Success\n@returns(204) No Content\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group listing_violation\n@endpoint GET /listing_violation\n@desc This call returns specific listing violations for the supported listing compliance types. Only one compliance type can be passed in per call, and the response will include all the listing violations for this compliance type, and listing violations are grouped together by eBay listing ID. See ComplianceTypeEnum for more information on the supported listing compliance types. This method also has pagination control.  Note: A maximum of 2000 listing violations will be returned in a result set. If the seller has more than 2000 listing violations, some/all of those listing violations must be corrected before additional listing violations will be retrieved. The user should pay attention to the total value in the response. If this value is '2000', it is possible that the seller has more than 2000 listing violations, but this field maxes out at 2000.  Note: In a future release of this API, the seller will be able to pass in a specific eBay listing ID as a query parameter to see if this specific listing has any violations.  Note: Only mocked non-compliant listing data will be returned for this call in the Sandbox environment, and not specific to the seller. However, the user can still use this mock data to experiment with the compliance type filters and pagination control.\n@required {X-EBAY-C-MARKETPLACE-ID: str # This header identifies the seller's eBay marketplace. Supported values for this header can be found in the MarketplaceIdEnum type definition., compliance_type: str # Note: The ASPECTS_ADOPTION compliance type has been deprecated and will be decommissioned on September 9th, 2025.This query parameter specifies the compliance type of the listing violations being retrieved. Only one compliance type value can be specified.  See ComplianceTypeEnum for more information on supported compliance types.}\n@optional {offset: str # The integer value input into this field controls the first listing violation in the result set that will be displayed at the top of the response. The offset and limit query parameters are used 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 set of violations.  Note: This feature employs a zero-based index, 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), listing_id: str # Note: This query parameter is not yet supported for the Compliance API., limit: str # This query parameter is used if the user wants to set a limit on the number of listing violations that are returned on one page of the 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 index, 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, filter: str # This filter allows a user to retrieve only listings that are currently out of compliance, or only listings that are at risk of becoming out of compliance. Although other filters may be added in the future, complianceState is the only supported filter type at this time. See the ComplianceStateEnum type for a list of supported values.Below is an example of how to set up this compliance state filter. Notice that the filter type and filter value are separated with a colon (:) character, and the filter value is wrapped with curly brackets. filter=complianceState:{OUT_OF_COMPLIANCE}}\n@returns(200) Success\n@returns(204) No Content\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}