Metadata API ドキュメント
メタデータ API(Metadata API)
メタデータ API には、さまざまな eBay マーケットプレイスに関する構成の詳細を取得する操作があります。マーケットプレイス情報に加えて、API には、販売者が eBay に商品を出品するのに役立つ情報を取得する操作もあります。
バージョン: v1.10.0
ベースURL: https://api.ebay.com/sell/metadata/v1
認証(OAuth スコープ)
この API では、エンドポイントに応じて以下の OAuth 2.0 スコープが使用されます。
| スコープ | 説明 |
|---|---|
https://api.ebay.com/oauth/api_scope |
アプリケーション スコープ(ほとんどのエンドポイントで使用) |
https://api.ebay.com/oauth/api_scope/sell.inventory |
在庫およびオファーの表示と管理(getItemConditionPolicies で追加使用) |
リソース一覧
Metadata API は以下の 4 つのリソースカテゴリで構成されています。
| リソース | 説明 | エンドポイント数 |
|---|---|---|
| marketplace | マーケットプレイスのカテゴリポリシー、出品条件、返品ポリシー、配送ポリシー、規制情報などのメタデータ取得 | 14 |
| compatibilities | 製品互換性プロパティ名/値の取得、仕様ベースの互換性検索 | 5 |
| shipping:marketplace | 配送キャリア、配送サービス、配送先/除外先、取り扱い時間の取得 | 5 |
| country | 売上税管轄区域の取得 | 3 |
marketplace — マーケットプレイスメタデータ
marketplace リソースは、マーケットプレイスのカテゴリに関するさまざまなポリシーとメタデータを提供します。
GET /marketplace/{marketplace_id}/get_automotive_parts_compatibility_policies
getAutomotivePartsCompatibilityPolicies — 指定されたマーケットプレイスのカテゴリに自動車部品の互換性アイテムをリストする方法を定義する eBay ポリシーを返します。
デフォルトでは、部品の互換性をサポートするすべてのカテゴリを返します。filter クエリパラメータで結果を制限できます。
注: eBay US マーケットプレイスのポリシーには EBAY_MOTORS_US を指定してください。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID。サポート: EBAY_MOTORS_US, EBAY_AU, EBAY_CA, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IT |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50。例: filter=categoryIds:{183521|183523} |
Accept-Encoding | ヘッダー | 任意 | gzip を指定して応答ペイロードを圧縮(推奨) |
レスポンス:
200— 成功 → AutomotivePartsCompatibilityPolicyResponse204— コンテンツなし400— リクエスト形式が不正404— 見つかりません500— 内部サーバーエラー
GET /marketplace/{marketplace_id}/get_category_policies
getCategoryPolicies — 指定されたマーケットプレイスのすべてのリーフカテゴリの eBay カテゴリポリシーメタデータを返します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50。例: filter=categoryIds:{3767|171784} |
レスポンス:
200— 成功 → CategoryPoliciesResponse204— コンテンツなし400/404/500
GET /marketplace/{marketplace_id}/get_classified_ad_policies
getClassifiedAdPolicies — 指定されたマーケットプレイスのすべてのリーフカテゴリの eBay 分類広告ポリシーメタデータを返します。
注: このメソッドは eBay US Motors カテゴリ(EBAY_MOTORS_US)の分類広告をサポートしていません。eBay Motors Pro ユーザーの場合は getMotorsListingPolicies を使用してください。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
レスポンス:
200— 成功 → ClassifiedAdPoliciesResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_currencies
getCurrencies — 指定されたマーケットプレイスでサポートされている通貨情報を返します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
レスポンス:
200— 成功 → GetCurrenciesResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_extended_producer_responsibility_policies
getExtendedProducerResponsibilityPolicies — eBay マーケットプレイスの拡張生産者責任(EPR)ポリシーを返します。
注: 拡張生産者責任 ID は出品レベルで設定されなくなったため、カテゴリレベルのメタデータは返されなくなりました。代わりに、販売者はアカウント設定で EPR を管理します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
Accept-Encoding | ヘッダー | 任意 | gzip(推奨) |
レスポンス:
200— 成功 → ExtendedProducerResponsibilityPolicyResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_hazardous_materials_labels
getHazardousMaterialsLabels — 指定された eBay マーケットプレイスの危険物ラベル情報(シグナルワード、ステートメント、ピクトグラム)を返します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
レスポンス:
200— 成功 → HazardousMaterialDetailsResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_item_condition_policies
getItemConditionPolicies — eBay マーケットプレイスのアイテム状態メタデータ(サポートされるアイテム状態 ID、状態記述子など)を返します。
重要: Certified - Refurbished 対象のセラーは、認証コード付与フローで作成された OAuth トークンと sell.inventory スコープを使用する必要があります。
OAuth スコープ: api_scope, sell.inventory
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50。例: filter=categoryIds:{100|101|102} |
Accept-Encoding | ヘッダー | 任意 | gzip(推奨) |
レスポンス:
200— 成功 → ItemConditionPolicyResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_listing_structure_policies
getListingStructurePolicies — 特定のマーケットプレイスのカテゴリで許可されている出品構造(バリエーションのある商品の出品可否など)を定義するポリシーを返します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
Accept-Encoding | ヘッダー | 任意 | gzip(推奨) |
レスポンス:
200— 成功 → ListingStructurePolicyResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_listing_type_policies
getListingTypePolicies — 指定されたマーケットプレイスのすべてのリーフカテゴリの eBay 出品タイプポリシーメタデータを返します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
レスポンス:
200— 成功 → ListingTypePoliciesResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_motors_listing_policies
getMotorsListingPolicies — 指定されたマーケットプレイスのすべてのリーフカテゴリの eBay Motors ポリシーメタデータを返します。
注: eBay US Motors カテゴリのポリシー情報を返すには、EBAY_MOTORS_US を指定します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
レスポンス:
200— 成功 → MotorsListingPoliciesResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_negotiated_price_policies
getNegotiatedPricePolicies — 特定のマーケットプレイスのカテゴリでサポートされている交渉価格機能(ベストオファーなど)を定義するポリシーを返します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
Accept-Encoding | ヘッダー | 任意 | gzip(推奨) |
レスポンス:
200— 成功 → NegotiatedPricePolicyResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_product_safety_labels
getProductSafetyLabels — 指定された eBay マーケットプレイスの製品安全ラベル情報(ステートメント、ピクトグラム)を返します。
注: EBAY_HK、EBAY_MY、EBAY_TW、EBAY_PH マーケットプレイスではサポートされていません。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
レスポンス:
200— 成功 → ProductSafetyLabelsResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_regulatory_policies
getRegulatoryPolicies — eBay マーケットプレイスの規制ポリシーを返します。
注: EBAY_HK、EBAY_MY、EBAY_TW、EBAY_PH ではサポートされていません。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
Accept-Encoding | ヘッダー | 任意 | gzip(推奨) |
レスポンス:
200— 成功 → RegulatoryPolicyResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_return_policies
getReturnPolicies — 特定のマーケットプレイスのカテゴリにリストするアイテムに返品ポリシーを含める必要があるかどうかを定義するポリシーと、国内および海外の返品ポリシーのガイドラインを返します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
Accept-Encoding | ヘッダー | 任意 | gzip(推奨) |
レスポンス:
200— 成功 → ReturnPolicyResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_shipping_policies
getShippingPolicies — 指定されたマーケットプレイスのすべてのリーフカテゴリの eBay 配送ポリシーメタデータを返します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
レスポンス:
200— 成功 → ShippingPoliciesResponse204/400/404/500
GET /marketplace/{marketplace_id}/get_site_visibility_policies
getSiteVisibilityPolicies — 指定されたマーケットプレイスのすべてのリーフカテゴリの eBay 国際サイト表示ポリシーメタデータを返します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
filter | クエリ | 任意 | カテゴリ ID でフィルタ。最大: 50 |
レスポンス:
200— 成功 → SiteVisibilityPoliciesResponse204/400/404/500
compatibilities — 製品互換性
compatibilities リソースは、パーツの互換性に関するプロパティ名、プロパティ値、および仕様ベースの互換性情報を取得するために使用されます。すべてのメソッドは POST で、リクエストボディにフィルター条件を含めます。
POST /compatibilities/get_compatibilities_by_specification
getCompatibilitiesBySpecification — 指定された仕様に基づいて、パーツの互換性のあるアプリケーション名と値のペアをすべて取得します。
タイヤの寸法(セクション幅やリム直径など)などの仕様を specifications コンテナーで提供し、compatibilityPropertyFilters 配列で結果を制限できます。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | 販売者の eBay マーケットプレイス |
Content-Type | ヘッダー | 必須 | application/json |
リクエストボディ: SpecificationRequest
レスポンス:
200— 成功 → SpecificationResponse204— コンテンツなし400/401/500
POST /compatibilities/get_compatibility_property_names
getCompatibilityPropertyNames — 指定された互換性対応カテゴリの製品互換性プロパティ名を取得します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | 販売者の eBay マーケットプレイス |
Content-Type | ヘッダー | 必須 | application/json |
リクエストボディ: PropertyNamesRequest
レスポンス:
200— 成功 → PropertyNamesResponse204/400/401/500
POST /compatibilities/get_compatibility_property_values
getCompatibilityPropertyValues — 指定されたカテゴリ内の単一のプロパティ名に関連付けられた製品互換性プロパティ値を取得します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | 販売者の eBay マーケットプレイス |
Content-Type | ヘッダー | 必須 | application/json |
リクエストボディ: PropertyValuesRequest
レスポンス:
200— 成功 → PropertyValuesResponse204/400/401/500
POST /compatibilities/get_multi_compatibility_property_values
getMultiCompatibilityPropertyValues — 指定されたカテゴリ内の複数のプロパティ名に関連付けられた製品互換性プロパティ値を取得します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | 販売者の eBay マーケットプレイス |
Content-Type | ヘッダー | 必須 | application/json |
リクエストボディ: MultiCompatibilityPropertyValuesRequest
レスポンス:
200— 成功 → MultiCompatibilityPropertyValuesResponse204/400/401/500
POST /compatibilities/get_product_compatibilities
getProductCompatibilities — 指定された商品の利用可能なすべてのアイテム互換性の詳細を取得します。
製品は productIdentifier(ePID、UPC 等)で指定します。dataset、datasetPropertyName、applicationPropertyFilter で結果を制限できます。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | 販売者の eBay マーケットプレイス |
Content-Type | ヘッダー | 必須 | application/json |
リクエストボディ: ProductRequest
レスポンス:
200— 成功 → ProductResponse204/400/401/500
shipping:marketplace — 配送メタデータ
shipping:marketplace リソースは、配送キャリア、配送サービス、配送先/除外先、取り扱い時間など、配送関連のメタデータを提供します。
GET /shipping/marketplace/{marketplace_id}/get_exclude_shipping_locations
getExcludeShippingLocations — 指定されたマーケットプレイスの配送除外先を取得します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
レスポンス:
200— 成功 → ShippingExcludeLocationResponse400/500
GET /shipping/marketplace/{marketplace_id}/get_handling_times
getHandlingTimes — 指定されたマーケットプレイスの取り扱い時間(ハンドリングタイム)を取得します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
レスポンス:
200— 成功 → ShippingHandlingTimeResponse400/500
GET /shipping/marketplace/{marketplace_id}/get_shipping_carriers
getShippingCarriers — 指定されたマーケットプレイスで利用可能な配送キャリアを取得します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
レスポンス:
200— 成功 → ShippingCarrierResponse400/500
GET /shipping/marketplace/{marketplace_id}/get_shipping_locations
getShippingLocations — 指定されたマーケットプレイスで利用可能な配送先を取得します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
レスポンス:
200— 成功 → ShippingLocationResponse400/500
GET /shipping/marketplace/{marketplace_id}/get_shipping_services
getShippingServices — 指定されたマーケットプレイスで利用可能な配送サービスを取得します。
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | パス | 必須 | eBay マーケットプレイス ID |
レスポンス:
200— 成功 → ShippingServiceResponse400/500
country — 売上税管轄区域
country リソースは、売上税管轄区域の情報を取得するために使用されます。
GET /country/{countryCode}/sales_tax_jurisdiction
getSalesTaxJurisdictions — 指定された国のすべての売上税管轄区域を取得します。
注: 売上税表は米国(EBAY_US)およびカナダ(EBAY_CA)のマーケットプレイスでのみ使用できます。米国では、eBay が全 50 州とワシントン DC の売上税を計算・徴収・納付しています。ただし、以下の米国領土では税率設定が可能です: AS, GU, MP, PW, VI
OAuth スコープ: api_scope
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
countryCode | パス | 必須 | 2 文字の ISO 3166 国コード。サポート値: US, CA |
レスポンス:
200— 成功 → SalesTaxJurisdictions400/404/500
主要スキーマ定義
Metadata API で使用される主要なリクエスト/レスポンスのデータモデルです(全 86 スキーマのうち主要なものを掲載)。
互換性リクエスト/レスポンス
SpecificationRequest
| フィールド | 型 | 説明 |
|---|---|---|
categoryId | string | 互換性対応カテゴリ ID |
compatibilityPropertyFilters | array[PropertyFilterInner] | 結果を制限するプロパティフィルタ |
dataset | array[string] | 返されるデータセットのタイプ |
datasetPropertyName | string | データセットのプロパティ名 |
exactMatch | boolean | 完全一致フィルタ |
paginationInput | PaginationInput | ページネーション設定 |
specifications | array[PropertyValues] | パーツの仕様(寸法、特性)の名前と値のペア |
SpecificationResponse
| フィールド | 型 | 説明 |
|---|---|---|
compatibilityDetails | array[CompatibilityDetails] | 互換性の詳細 |
pagination | Pagination | ページネーション情報 |
PropertyNamesRequest
| フィールド | 型 | 説明 |
|---|---|---|
categoryId | string | 互換性対応カテゴリ ID(必須) |
dataset | array[string] | 返されるプロパティのタイプ(任意) |
PropertyNamesResponse
| フィールド | 型 | 説明 |
|---|---|---|
categoryId | string | カテゴリ ID |
properties | array[PropertyNamesResponseProperties] | プロパティ名の配列 |
PropertyValuesRequest
| フィールド | 型 | 説明 |
|---|---|---|
categoryId | string | 互換性対応カテゴリ ID(必須) |
propertyName | string | 値を取得するプロパティ名(必須) |
propertyFilters | array[PropertyFilterInner] | 結果を制限するフィルタ |
sortOrder | array[SortOrderInner] | ソート順序 |
PropertyValuesResponse
| フィールド | 型 | 説明 |
|---|---|---|
metadataVersion | string | メタデータバージョン |
propertyName | string | プロパティ名 |
propertyValues | array[PropertyValues] | プロパティ値の配列 |
MultiCompatibilityPropertyValuesRequest
| フィールド | 型 | 説明 |
|---|---|---|
categoryId | string | 互換性対応カテゴリ ID(必須) |
propertyNames | array[string] | 値を取得するプロパティ名の配列(必須) |
propertyFilters | array[PropertyFilterInner] | 結果を制限するフィルタ(必須) |
MultiCompatibilityPropertyValuesResponse
| フィールド | 型 | 説明 |
|---|---|---|
compatibilities | array[Compatibility] | 互換性情報の配列 |
metadataVersion | string | メタデータバージョン |
ProductRequest
| フィールド | 型 | 説明 |
|---|---|---|
productIdentifier | ProductIdentifier | 製品の識別子(ePID、UPC 等) |
applicationPropertyFilters | array[PropertyFilterInner] | アプリケーションフィルタ |
dataset | array[string] | データセットタイプ |
datasetPropertyName | string | データセットプロパティ名 |
disabledProductFilter | DisabledProductFilter | 無効化された製品フィルタ |
paginationInput | PaginationInput | ページネーション |
ProductResponse
| フィールド | 型 | 説明 |
|---|---|---|
compatibilityDetails | array[ProductResponseCompatibilityDetails] | 互換性の詳細 |
pagination | Pagination | ページネーション情報 |
マーケットプレイスポリシーレスポンス(主要)
ItemConditionPolicyResponse
| フィールド | 型 | 説明 |
|---|---|---|
itemConditionPolicies | array[ItemConditionPolicy] | カテゴリごとのアイテム状態ポリシー |
warnings | array[Error] | 警告 |
ItemConditionPolicy
| フィールド | 型 | 説明 |
|---|---|---|
categoryId | string | カテゴリ ID |
categoryTreeId | string | カテゴリツリー ID |
itemConditionRequired | boolean | アイテム状態が必須かどうか |
itemConditions | array[ItemCondition] | サポートされるアイテム状態の配列 |
ListingStructurePolicyResponse
| フィールド | 型 | 説明 |
|---|---|---|
listingStructurePolicies | array[ListingStructurePolicy] | 出品構造ポリシーの配列(variationsSupported 含む) |
warnings | array[Error] | 警告 |
ListingTypePoliciesResponse
| フィールド | 型 | 説明 |
|---|---|---|
listingTypePolicies | array[ListingTypePolicy] | 出品タイプポリシーの配列(listingDurations, pickupDropOffEnabled 含む) |
warnings | array[Error] | 警告 |
NegotiatedPricePolicyResponse
| フィールド | 型 | 説明 |
|---|---|---|
negotiatedPricePolicies | array[NegotiatedPricePolicy] | 交渉価格ポリシーの配列(bestOfferAutoAcceptEnabled 等含む) |
warnings | array[Error] | 警告 |
ReturnPolicyResponse
| フィールド | 型 | 説明 |
|---|---|---|
returnPolicies | array[ReturnPolicy] | 返品ポリシーの配列(domestic, international, required 含む) |
warnings | array[Error] | 警告 |
ShippingPoliciesResponse
| フィールド | 型 | 説明 |
|---|---|---|
shippingPolicies | array[ShippingPolicy] | 配送ポリシーの配列(globalShippingEnabled, maxFlatShippingCost 等含む) |
warnings | array[Error] | 警告 |
MotorsListingPoliciesResponse
| フィールド | 型 | 説明 |
|---|---|---|
motorsListingPolicies | array[MotorsListingPolicy] | Motors ポリシーの配列(depositSupported, ebayMotorsProAdFormatEnabled 等含む) |
warnings | array[Error] | 警告 |
SiteVisibilityPoliciesResponse
| フィールド | 型 | 説明 |
|---|---|---|
siteVisibilityPolicies | array[SiteVisibilityPolicy] | サイト表示ポリシーの配列(crossBorderTradeAustraliaEnabled 等含む) |
warnings | array[Error] | 警告 |
規制・安全レスポンス
ExtendedProducerResponsibilityPolicyResponse
| フィールド | 型 | 説明 |
|---|---|---|
extendedProducerResponsibilities | array[ExtendedProducerResponsibilityPolicy] | EPR ポリシーの配列 |
warnings | array[Error] | 警告 |
HazardousMaterialDetailsResponse
| フィールド | 型 | 説明 |
|---|---|---|
signalWords | array[SignalWord] | シグナルワードの配列(signalWordId, signalWordDescription) |
statements | array[HazardStatement] | 危険ステートメントの配列(statementId, statementDescription) |
pictograms | array[Pictogram] | ピクトグラムの配列(pictogramId, pictogramDescription, pictogramUrl) |
ProductSafetyLabelsResponse
| フィールド | 型 | 説明 |
|---|---|---|
pictograms | array[ProductSafetyLabelPictogram] | ピクトグラムの配列 |
statements | array[ProductSafetyLabelStatement] | ステートメントの配列 |
RegulatoryPolicyResponse
| フィールド | 型 | 説明 |
|---|---|---|
regulatoryPolicies | array[RegulatoryPolicy] | 規制ポリシーの配列(categoryId, supportedAttributes 含む) |
warnings | array[Error] | 警告 |
通貨・税金レスポンス
GetCurrenciesResponse
| フィールド | 型 | 説明 |
|---|---|---|
defaultCurrency | Currency | マーケットプレイスのデフォルト通貨 |
marketplaceId | string | マーケットプレイス ID |
SalesTaxJurisdictions
| フィールド | 型 | 説明 |
|---|---|---|
salesTaxJurisdictions | array[SalesTaxJurisdiction] | 売上税管轄区域の配列(salesTaxJurisdictionId 含む) |
配送メタデータレスポンス
ShippingCarrierResponse
| フィールド | 型 | 説明 |
|---|---|---|
shippingCarriers | array[ShippingCarrier] | 配送キャリアの配列(shippingCarrier, description) |
ShippingServiceResponse
| フィールド | 型 | 説明 |
|---|---|---|
shippingServices | array[ShippingService] | 配送サービスの配列(description, internationalService, minShippingTime, maxShippingTime, shippingCarrier, packageLimits 含む) |
ShippingExcludeLocationResponse
| フィールド | 型 | 説明 |
|---|---|---|
excludeShippingLocations | array[ShippingExcludeLocation] | 配送除外先の配列(location, description, region) |
ShippingLocationResponse
| フィールド | 型 | 説明 |
|---|---|---|
shippingLocations | array[ShippingLocation] | 配送先の配列(shippingLocation, description) |
ShippingHandlingTimeResponse
| フィールド | 型 | 説明 |
|---|---|---|
handlingTimes | array[ShippingHandlingTime] | 取り扱い時間の配列(description, extendedHandling, maxHandlingTime) |
共通スキーマ
ProductIdentifier
| フィールド | 型 | 説明 |
|---|---|---|
epid | string | eBay 製品 ID |
ean | string | European Article Number |
isbn | string | ISBN |
upc | string | Universal Product Code |
productId | string | 汎用製品 ID |
PropertyFilterInner
| フィールド | 型 | 説明 |
|---|---|---|
propertyName | string | プロパティ名 |
propertyValue | string | プロパティ値 |
unitOfMeasurement | string | 計測単位 |
url | string | URL |
PaginationInput / Pagination
| フィールド | 型 | 説明 |
|---|---|---|
limit | integer | ページあたりの最大結果数 |
offset | integer | スキップする結果数 |
count | integer | 現在のページの結果数(Pagination のみ) |
total | integer | 合計結果数(Pagination のみ) |
Error
| フィールド | 型 | 説明 |
|---|---|---|
category | string | エラーカテゴリ |
domain | string | エラードメイン |
errorId | integer | エラー ID |
inputRefIds | array[string] | 入力参照 ID |
longMessage | string | 詳細メッセージ |
message | string | 短いメッセージ |
outputRefIds | array[string] | 出力参照 ID |
parameters | array[ErrorParameter] | エラーパラメータ |
エンドポイント一覧
| メソッド | エンドポイント | operationId | リソース |
|---|---|---|---|
| GET | /marketplace/{id}/get_automotive_parts_compatibility_policies | getAutomotivePartsCompatibilityPolicies | marketplace |
| GET | /marketplace/{id}/get_category_policies | getCategoryPolicies | marketplace |
| GET | /marketplace/{id}/get_classified_ad_policies | getClassifiedAdPolicies | marketplace |
| GET | /marketplace/{id}/get_currencies | getCurrencies | marketplace |
| GET | /marketplace/{id}/get_extended_producer_responsibility_policies | getExtendedProducerResponsibilityPolicies | marketplace |
| GET | /marketplace/{id}/get_hazardous_materials_labels | getHazardousMaterialsLabels | marketplace |
| GET | /marketplace/{id}/get_item_condition_policies | getItemConditionPolicies | marketplace |
| GET | /marketplace/{id}/get_listing_structure_policies | getListingStructurePolicies | marketplace |
| GET | /marketplace/{id}/get_listing_type_policies | getListingTypePolicies | marketplace |
| GET | /marketplace/{id}/get_motors_listing_policies | getMotorsListingPolicies | marketplace |
| GET | /marketplace/{id}/get_negotiated_price_policies | getNegotiatedPricePolicies | marketplace |
| GET | /marketplace/{id}/get_product_safety_labels | getProductSafetyLabels | marketplace |
| GET | /marketplace/{id}/get_regulatory_policies | getRegulatoryPolicies | marketplace |
| GET | /marketplace/{id}/get_return_policies | getReturnPolicies | marketplace |
| GET | /marketplace/{id}/get_shipping_policies | getShippingPolicies | marketplace |
| GET | /marketplace/{id}/get_site_visibility_policies | getSiteVisibilityPolicies | marketplace |
| POST | /compatibilities/get_compatibilities_by_specification | getCompatibilitiesBySpecification | compatibilities |
| POST | /compatibilities/get_compatibility_property_names | getCompatibilityPropertyNames | compatibilities |
| POST | /compatibilities/get_compatibility_property_values | getCompatibilityPropertyValues | compatibilities |
| POST | /compatibilities/get_multi_compatibility_property_values | getMultiCompatibilityPropertyValues | compatibilities |
| POST | /compatibilities/get_product_compatibilities | getProductCompatibilities | compatibilities |
| GET | /shipping/marketplace/{id}/get_exclude_shipping_locations | getExcludeShippingLocations | shipping:marketplace |
| GET | /shipping/marketplace/{id}/get_handling_times | getHandlingTimes | shipping:marketplace |
| GET | /shipping/marketplace/{id}/get_shipping_carriers | getShippingCarriers | shipping:marketplace |
| GET | /shipping/marketplace/{id}/get_shipping_locations | getShippingLocations | shipping:marketplace |
| GET | /shipping/marketplace/{id}/get_shipping_services | getShippingServices | shipping:marketplace |
| GET | /country/{countryCode}/sales_tax_jurisdiction | getSalesTaxJurisdictions | country |