ストア API（Store API）

この API は、サードパーティの開発者向けにストア関連のリソースを提供します。これらのリソースを使用すると、ストア名、説明、ストア URL などの基本的なストア情報を取得したり、ストア カテゴリ階層を返したり、単一ユーザーの eBay ストア カテゴリを追加、名前変更、移動、削除したり、これらのタスクの処理ステータスを取得したりできます。

バージョン: 1

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

認証（OAuth スコープ）

ストア リソース メソッドには、承認コード付与フローで作成されたアクセス トークンが必要です。

リソース一覧

Store API は以下の 3 つのリソースカテゴリで構成されています。

重要: カテゴリの変更（追加・名前変更・移動・削除）は非同期で処理されます。カテゴリの変更を開始すると、前の変更リクエストが完了するまで、追加のカテゴリ変更を行うことはできません。最後のリクエストの最新のステータスを取得するには、getStoreTask または getStoreTasks メソッドを使用します。

store — ストア情報

store リソースは、eBay ユーザーのストアの基本情報（名前、説明、URL、ロゴなど）を取得するために使用されます。

GET /store

getStore — eBay ユーザーのストアの情報（ストア名、ストア URL、説明など）を取得します。

OAuth スコープ: sell.stores

レスポンス:

• 200 — 成功 → GetStoreResponseType
• 400 — リクエスト形式が不正
• 500 — 内部サーバーエラー

store categories — ストア カテゴリ管理

store categories リソースは、eBay ストアのカスタム カテゴリ階層を取得・管理するために使用されます。eBay ストアでは最大 3 レベルのカテゴリ階層がサポートされています。

GET /store/categories

getStoreCategories — eBay ユーザーのストアのカテゴリ階層を取得します。

注: 3 レベルのストア カテゴリがサポートされています。

OAuth スコープ: sell.stores

レスポンス:

• 200 — 成功 → GetStoreCategoriesResponseType
• 400 — リクエスト形式が不正
• 500 — 内部サーバーエラー

POST /store/categories

addStoreCategory — 非同期リクエストを通じてユーザーの eBay ストアに 1 つの新しいカスタム カテゴリを追加します。

呼び出しが成功すると、Location 応答ヘッダーに getStoreTask URI が返されます。カテゴリ追加操作のステータスを取得するには、getStoreTask（または getStoreTasks）メソッドを呼び出します。

OAuth スコープ: sell.stores

リクエストボディ: AddStoreCategoryRequestType

レスポンス:

• 202 — リクエスト承認済み（非同期タスクのステータスを取得するために Location ヘッダーの URL を使用）
• 400 — リクエスト形式が不正
• 500 — 内部サーバーエラー

POST /store/categories/move_category

moveStoreCategory — 非同期リクエストを通じて、既存のユーザーの eBay ストアのカスタム カテゴリを移動します。

呼び出しが成功すると、Location 応答ヘッダーに getStoreTask URI が返されます。ユーザーは getStoreTask を呼び出して、カテゴリ移動操作のステータスを取得します。

OAuth スコープ: sell.stores

リクエストボディ: MoveStoreCategoryRequestType

レスポンス:

• 202 — リクエスト承認済み（非同期タスクのステータスを取得するために Location ヘッダーの URL を使用）
• 400 — リクエスト形式が不正
• 500 — 内部サーバーエラー

PUT /store/categories/{category_id}

renameStoreCategory — 非同期リクエストを通じてユーザーの eBay ストアの単一のカテゴリの名前を変更します。

呼び出しが成功すると、Location 応答ヘッダーに getStoreTask URI が返されます。ユーザーは getStoreTask を呼び出して、カテゴリの名前変更操作のステータスを取得します。

OAuth スコープ: sell.stores

リクエストボディ: RenameStoreCategoryRequestType

レスポンス:

• 204 — コンテンツなし（名前変更成功）
• 400 — リクエスト形式が不正
• 500 — 内部サーバーエラー

DELETE /store/categories/{category_id}

deleteStoreCategory — 非同期リクエストを通じてユーザーの eBay ストアのカスタム カテゴリを 1 つ削除します。

呼び出しが成功すると、Location レスポンス ヘッダーに getStoreTask URI が返されます。カテゴリ削除操作のステータスを取得するには、getStoreTask（または getStoreTasks）メソッドを呼び出します。

OAuth スコープ: sell.stores

リクエストボディ: DeleteStoreCategoryRequestType

レスポンス:

• 202 — リクエスト承認済み（非同期タスクのステータスを取得するために Location ヘッダーの URL を使用）
• 400 — リクエスト形式が不正
• 500 — 内部サーバーエラー

store tasks — 非同期タスク管理

store tasks リソースは、ストア カテゴリの変更操作（追加・名前変更・移動・削除）の非同期タスクのステータスを取得するために使用されます。実行時間が 24 時間に達すると、すべてのタスクは FAILED または COMPLETED に設定されます。

GET /store/tasks

getStoreTasks — ストアのすべての非同期ストア タスクのステータスを取得します。

OAuth スコープ: sell.stores

レスポンス:

• 200 — 成功 → GetStoreTasksResponseType
• 400 — リクエスト形式が不正
• 500 — 内部サーバーエラー

GET /store/tasks/{task_id}

getStoreTask — 最近のストア操作の現在のステータスを取得します。

OAuth スコープ: sell.stores

レスポンス:

• 200 — 成功 → GetStoreTaskResponseType
• 400 — リクエスト形式が不正
• 500 — 内部サーバーエラー

スキーマ定義

Store API で使用されるリクエスト/レスポンスのデータモデル定義です。

リクエスト スキーマ

AddStoreCategoryRequestType

ストア カテゴリ追加リクエストのペイロード。

RenameStoreCategoryRequestType

ストア カテゴリ名前変更リクエストのペイロード。

MoveStoreCategoryRequestType

ストア カテゴリ移動リクエストのペイロード。

DeleteStoreCategoryRequestType

ストア カテゴリ削除リクエストのペイロード。

レスポンス スキーマ

GetStoreResponseType

ストア情報のレスポンスモデル。販売者の eBay ストアを記述します。

GetStoreCategoriesResponseType

ストア カテゴリ階層のレスポンスモデル。

GetStoreTaskResponseType

単一ストア タスクのレスポンスモデル。

GetStoreTasksResponseType

複数ストア タスクのレスポンスモデル。

共通スキーマ

StoreCategoryType

カスタム eBay ストア カテゴリの詳細。

StoreLogoType

ストアロゴの情報。

StoreTaskType

ストアタスクのステータス詳細。

Error

エラーレスポンスモデル。

ErrorParameter

エラーパラメータ。

エンドポイント一覧