スコープ
BASE API のアクセストークン(Personal Access Token)は、許可された操作の範囲を スコープで表します。各エンドポイントが要求するスコープを持つトークンでのみ、 そのエンドポイントを呼び出せます。
スコープの形式
スコープは {リソース}.{アクション} の形式です(例: items.read,
items.create)。書き込み系スコープは対応する読み取りスコープを併せて要求します
(例: items.create は items.read を要求します)。
従属リソース(例: item category)は親リソースの読み取りスコープに暗黙的に含まれます。 個別のスコープは用意しません。
利用可能なスコープ
| スコープ | 説明 |
|---|---|
files.write |
|
item_categories.write |
|
items.create |
|
items.delete |
|
items.publish |
|
items.read |
|
items.update |
|
orders.cancel |
|
orders.dispatch |
|
orders.read |
|
orders.update |
|
user.read |
初期リリースの範囲
初期リリースでは OAuth フローと検索系エンドポイントは提供しません。トークンは Personal Access Token のみで、対象スコープは上表のとおりです。