eBay

Compliance API

Service for providing information to sellers about their listings being non-compliant, or at risk for becoming non-compliant, against eBay listing policies.

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Service for providing information to sellers about their listings being non-compliant, or at risk for becoming non-compliant, against eBay listing policies.

Endpoints 3

listing_violation

  • GETgetListingViolations/listing_violation?compliance_type=string&offset=string&listing_id=string&limit=string&filter=stringThis call returns specific listing violations for the supported listing compliance types. Only one compliance type can be passed in per call, and the response…
  • POSTsuppressViolation/suppress_listing_violationThis call suppresses a listing violation for a specific listing. Only listing violations in the AT_RISK state (returned in the violations.complianceState…

listing_violation_summary

  • GETgetListingViolationsSummary/listing_violation_summary?compliance_type=stringThis 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…

API details

Base URL
https://api.ebay.com{basePath}
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
Operations
3 operations on 3 pathsGET 2POST 1
Main resources
listing_violation 2listing_violation_summary 1
Response formats
application/json;charset=utf-8
Description format
OpenAPI 3.0.0, API version 1.4.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Compliance API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Compliance API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “getListingViolations” (GET /listing_violation?compliance_type=string&offset=string&listing_id=string&limit=string&filter=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Compliance API?

Service for providing information to sellers about their listings being non-compliant, or at risk for becoming non-compliant, against eBay listing policies. It is listed under E-commerce and has 3 endpoints.

Who publishes the Compliance API?

It is listed from eBay's public API description (an OpenAPI document), not published by eBay on Swastik Codes. Anyone who controls ebay.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Compliance API?

Requests go to https://api.ebay.com{basePath}. Endpoint paths are added to this base URL.

How do I authenticate with the Compliance API?

With OAuth 2.0 (authorization code flow) with 1 scope.

How many endpoints does the Compliance API have?

3 operations on 3 paths (2 GET, 1 POST). The largest groups are listing_violation, listing_violation_summary.

Is forking the Compliance API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.