API を呼び出す前に
認証
認証を確認します。
利用可能な最低プラン
必要な API 機能がストアのプランに含まれているか確認します。
必要な権限
キーの権限と送信するフィールドの条件を確認します。
必要なプラン
| 利用可能な最低プラン | 説明 |
|---|---|
| BASIC | BASIC では注文と顧客の申請の取得、それらのステータス変更、注文の支払いステータス変更、記録された返金額の変更ができます。 |
| STANDARD | カタログ、CMS、検索、在庫の操作には STANDARD 以上のプランが必要です。 |
既存の契約ストアにも、そのプランに含まれる API 機能が提供されます。
操作ごとの権限
- リファレンスには操作ごとの required_scopes と、機密性のあるフィールドや変更に必要な conditional_scopes を記載しています。
- 取得権限だけでは作成、編集、削除はできません。
- リソース権限の記載がない場合でも、トークン発行とコンテキストの取得には認証が必要です。
一覧取得
GET/api/v1/products
- 認証
Bearer- 利用可能な最低プラン
- STANDARD
- 必要な権限
catalog.product:read
更新
PATCH/api/v1/products/{product_id}
- 認証
Bearer- 利用可能な最低プラン
- STANDARD
- 必要な権限
catalog.product:update
追加の権限が必要な場合
更新
PATCH/api/v1/products/{product_id}
- 認証
Bearer- 利用可能な最低プラン
- STANDARD
- 必要な権限
catalog.product:update- 特定のフィールドに必要な追加権限
- variant_value_ids を指定した場合:
catalog.product_variant:create,catalog.product_variant:update,catalog.product_variant:delete - variants_enabled を指定した場合:
catalog.product_variant:update
- variant_value_ids を指定した場合:
プラン変更時の動作
プランのダウングレードで権限が失われると、API キーからその権限が削除され、管理画面ではチェックが外れて選択できなくなります。