Compliance API ドキュメント

コンプライアンス API（Compliance API）

Compliance API は、出品者が eBay 出品ポリシーに準拠していないか、準拠しなくなるリスクがあるかどうかに関する情報を提供するサービスです。出品違反の詳細と違反数のサマリーを取得できます。

バージョン: 1.4.4

ベースURL: https://api.ebay.com/sell/compliance/v1

認証（OAuth スコープ）

この API は 認可コード（Authorization Code） フローを使用します。ユーザーの認可が必要です。

スコープ	説明
`https://api.ebay.com/oauth/api_scope/sell.inventory`	在庫とオファーの表示と管理

リソース一覧

Compliance API は以下の 2 リソース、合計 2 エンドポイント（すべて GET）で構成されています。

リソース	説明	数
listing_violation	出品コンプライアンスタイプに固有の出品違反の詳細を取得	1
listing_violation_summary	出品違反数のサマリーを取得	1

listing_violation — 出品違反の詳細（1 エンドポイント）

GET `/listing_violation`

getListingViolations — サポートされている出品コンプライアンスタイプに固有の出品違反を返します。1 回の呼び出しで指定できるコンプライアンスタイプは 1 つのみです。応答には、このコンプライアンスタイプのすべての出品違反が含まれ、eBay 出品 ID ごとにグループ化されます。

注: 結果セットには最大 2,000 件の出品違反が返されます。出品者の違反が 2,000 件を超える場合、追加の違反を取得する前に一部またはすべてを修正する必要があります。

注: サンドボックス環境ではセラー固有ではなく、模擬の非準拠出品データのみが返されます。

パラメータ	場所	必須	説明
`X-EBAY-C-MARKETPLACE-ID`	ヘッダー	必須	販売者の eBay マーケットプレイスを識別。値は MarketplaceIdEnum を参照。
`compliance_type`	クエリ	必須	取得する出品違反のコンプライアンスタイプ。1 つのみ指定可能。値は ComplianceTypeEnum を参照。
`filter`	クエリ	任意	コンプライアンス状態でフィルタリング。構文: `filter=complianceState:{OUT_OF_COMPLIANCE}`。値は ComplianceStateEnum を参照。
`listing_id`	クエリ	任意	特定の出品 ID でフィルタリング（現在未サポート、将来のリリースで対応予定）。
`offset`	クエリ	任意	結果セットでスキップする件数。ゼロベースインデックス。デフォルト: 0
`limit`	クエリ	任意	1 ページに返される出品違反の最大数。デフォルト: 100、最大: 200

レスポンス: 200 → PagedComplianceViolationCollection / 204 / 400 / 500

listing_violation_summary — 出品違反サマリー（1 エンドポイント）

GET `/listing_violation_summary`

getListingViolationsSummary — セラーの出品違反数を返します。1 つ以上のコンプライアンスタイプを指定できます。セラーが複数の eBay マーケットプレイスで販売している場合、複数のマーケットプレイスの違反数が返されます。

注: サンドボックス環境では、すべてのコンプライアンスタイプのカウントを含む定型応答のみが返されます。

パラメータ	場所	必須	説明
`X-EBAY-C-MARKETPLACE-ID`	ヘッダー	必須	販売者の eBay マーケットプレイスを識別。
`compliance_type`	クエリ	任意	取得するコンプライアンスタイプ。カンマ区切りで複数指定可能。省略時はすべてのタイプの出品数が返されます。

レスポンス: 200 → ComplianceSummary / 204 / 400 / 500

スキーマ定義（全 12 スキーマ）

違反詳細

PagedComplianceViolationCollection

フィールド	型	説明
`listingViolations`	array[ComplianceViolation]	出品違反の配列
`href`	string	現在の結果セットの URI
`total`	integer	一致する出品違反の総数（上限: 2,000）
`next`	string	次ページの URI
`prev`	string	前ページの URI
`offset`	integer	オフセット
`limit`	integer	1 ページの最大件数

ComplianceViolation

フィールド	型	説明
`complianceType`	string	コンプライアンスタイプ
`listingId`	string	eBay 出品 ID
`sku`	string	SKU
`offerId`	string	オファー ID
`violations`	array[ComplianceDetail]	違反詳細の配列

ComplianceDetail

フィールド	型	説明
`reasonCode`	string	違反理由コード
`message`	string	違反の説明メッセージ
`complianceState`	string	コンプライアンス状態: `OUT_OF_COMPLIANCE`、`AT_RISK`
`variation`	VariationDetails	バリエーション詳細（該当する場合）
`violationData`	array[NameValueList]	違反データの名前/値ペア
`correctiveRecommendations`	CorrectiveRecommendations	修正推奨事項

VariationDetails

フィールド	型	説明
`sku`	string	バリエーションの SKU
`variationAspects`	array[NameValueList]	バリエーションアスペクトの名前/値ペア

CorrectiveRecommendations

フィールド	型	説明
`productRecommendation`	ProductRecommendation	製品推奨事項
`aspectRecommendations`	array[AspectRecommendations]	アスペクト推奨事項

ProductRecommendation

フィールド	型	説明
`epid`	string	推奨される eBay 製品 ID

AspectRecommendations

フィールド	型	説明
`localizedAspectName`	string	ローカライズされたアスペクト名
`suggestedValues`	array[string]	推奨される値の配列

サマリー

ComplianceSummary

フィールド	型	説明
`violationSummaries`	array[ComplianceSummaryInfo]	コンプライアンスタイプごとの違反サマリー

ComplianceSummaryInfo

フィールド	型	説明
`complianceType`	string	コンプライアンスタイプ
`marketplaceId`	string	マーケットプレイス ID
`listingCount`	integer	出品違反数

共通スキーマ

NameValueList

フィールド	型	説明
`name`	string	名前
`value`	string	値

Error

フィールド	型	説明
`category`	string	エラーカテゴリ
`domain`	string	エラードメイン
`errorId`	integer	エラー ID
`message`	string	短いメッセージ
`longMessage`	string	詳細メッセージ
`inputRefIds`	array[string]	入力参照 ID
`outputRefIds`	array[string]	出力参照 ID
`parameters`	array[ErrorParameter]	エラーパラメータ
`subdomain`	string	エラーサブドメイン

ErrorParameter

フィールド	型	説明
`name`	string	パラメータ名
`value`	string	パラメータ値

エンドポイント一覧（全 2 エンドポイント）

メソッド	エンドポイント	operationId	説明
GET	`/listing_violation`	getListingViolations	出品違反の詳細を取得
GET	`/listing_violation_summary`	getListingViolationsSummary	出品違反数のサマリーを取得