{
  "opencollection": "1.0.0",
  "info": {
    "name": "eBay Account Advertising_eligibility Listing_violation API",
    "version": "v1.9.2"
  },
  "items": [
    {
      "info": {
        "name": "Listing_violation",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "getListingViolations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ebay.com{basePath}/listing_violation",
            "headers": [
              {
                "name": "X-EBAY-C-MARKETPLACE-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compliance_type",
                "value": "",
                "type": "query",
                "description": "This query parameter specifies the compliance type of the listing violations being retrieved. Only one compliance type value can be specified. <br> <br>See <a href=\"/api-docs/sell/compliance/types/com:ComplianceTypeEnum\">ComplianceTypeEnum</a> for more information on supported compliance types."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "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 <strong>offset</strong> and <strong>limit</strong> query parameters are used to control the pagination of the output. For example, if <strong>offset</strong> is set to <code>10</code> and <strong>limit</strong> is set to <code>10</code>, the call retrieves listing violations 11 thru 20 from the resulting set of violations. <br /><br /> <span class=\"tablenote\"><strong>Note:</strong> This feature employs a zero-based index, where the first item in the list has an offset of <code>0</code>. If the <strong>listing_id</strong> parameter is included in the request, this parameter will be ignored.</span><br/><br/> <strong>Default: </strong> <code>0</code> {zero)"
              },
              {
                "name": "listing_id",
                "value": "",
                "type": "query",
                "description": "<span class=\"tablenote\"><strong>Note:</strong> This query parameter is not yet supported for the Compliance API.</span>"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "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 <strong>offset</strong> parameter to control the pagination of the output.<br /><br />For example, if <strong>offset</strong> is set to <code>10</code> and <strong>limit</strong> is set to <code>10</code>, the call retrieves listing violations 11 thru 20 from the collection of listing violations that match the value set in the <strong>compliance_type</strong> parameter.<br /><br /><span class=\"tablenote\"><strong>Note:</strong> This feature employs a zero-based index, where the first item in the list has an offset of <code>0</code>. If the <strong>listing_id</strong> parameter is included in the request, this parameter will be ignored.</span><br/><br/><strong>Default:</strong> <code>100</code><br/> <strong>Maximum:</strong> <code>200</code>"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "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.<br><br> Although other filters may be added in the future, <code>complianceState</code> is the only supported filter type at this time. See the <a href=\"/api-docs/sell/compliance/types/com:ComplianceStateEnum\">ComplianceStateEnum</a> type for a list of supported values.<br><br>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.<br><br> <code>filter=complianceState:{OUT_OF_COMPLIANCE}</code>"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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 <a href=\"/api-docs/sell/compliance/types/com:ComplianceTypeEnum\">ComplianceTypeEnum</a> for more information on the supported listing compliance types. This method also has pagination control. <br /><br /> <"
        }
      ]
    }
  ],
  "bundled": true
}