API リファレンス
BASE API で利用できる全 37 エンドポイントの一覧です。 呼び出しには、各エンドポイントが要求するスコープを含むアクセストークンが必要です（スコープ）。
| 概要 | メソッド / パス | 必要スコープ |
|---|---|---|
| 商品 17 件 商品の取得・作成・編集と在庫の管理。 | ||
| 商品一覧取得 |
GET /api/items
|
items.read |
| 商品作成 |
POST /api/items
|
items.createitems.read |
| 商品詳細取得 |
GET /api/items/{id}
|
items.read |
| 商品編集 |
POST /api/items/{id}
|
items.readitems.update |
| 商品削除 |
DELETE /api/items/{id}
|
items.deleteitems.read |
| 種類一覧取得 |
GET /api/items/{id}/variations
|
items.read |
| 種類追加 |
POST /api/items/{id}/variations
|
items.readitems.update |
| 種類の並び替え |
PUT /api/items/{id}/variations
|
items.readitems.update |
| 種類編集 |
POST /api/items/{id}/variations/{variation_id}
|
items.readitems.update |
| 種類削除 |
DELETE /api/items/{id}/variations/{variation_id}
|
items.readitems.update |
| 在庫設定 |
PUT /api/items/{id}/stock
|
items.readitems.update |
| 画像一覧取得 |
GET /api/items/{id}/images
|
items.read |
| 画像追加 |
POST /api/items/{id}/images
|
items.readitems.update |
| 画像の並び替え |
PUT /api/items/{id}/images
|
items.readitems.update |
| 画像削除 |
DELETE /api/items/{id}/images/{image_id}
|
items.readitems.update |
| 公開状態の切り替え |
PUT /api/items/{id}/visibility
|
items.publishitems.read |
| 並び順の変更 |
PUT /api/items/{id}/list_order
|
items.readitems.update |
| 商品カテゴリ 8 件 商品を分類するカテゴリの管理と、商品との結びつけ。 | ||
| カテゴリ一覧取得 |
GET /api/item_categories
|
items.read |
| カテゴリ作成 |
POST /api/item_categories
|
item_categories.writeitems.read |
| カテゴリ取得 |
GET /api/item_categories/{id}
|
items.read |
| カテゴリ編集 |
POST /api/item_categories/{id}
|
item_categories.writeitems.read |
| カテゴリ削除 |
DELETE /api/item_categories/{id}
|
item_categories.writeitems.read |
| カテゴリの並び順を変更する |
PUT /api/item_categories/{id}/list_order
|
item_categories.writeitems.read |
| カテゴリに商品を追加 |
PUT /api/item_categories/{id}/items/{item_id}
|
items.readitems.update |
| カテゴリから商品を削除 |
DELETE /api/item_categories/{id}/items/{item_id}
|
items.readitems.update |
| 注文 9 件 注文の参照・検索・更新と発送・キャンセル。 | ||
| 注文取得 |
GET /api/orders/{unique_key}
|
orders.read |
| 注文内容更新 |
PUT /api/orders/{unique_key}
|
orders.readorders.update |
| 注文検索 |
POST /api/orders/search
|
orders.read |
| 注文キャンセル |
POST /api/orders/{unique_key}/cancel
|
orders.cancelorders.read |
| 注文発送 |
POST /api/orders/{unique_key}/dispatch
|
orders.dispatchorders.read |
| 注文メールアドレス更新 |
PUT /api/orders/{unique_key}/customer
|
orders.readorders.update |
| 注文配送先更新 |
PUT /api/orders/{unique_key}/shipping
|
orders.readorders.update |
| 注文配送希望日時更新 |
PUT /api/orders/{unique_key}/delivery
|
orders.readorders.update |
| 注文ショップメモ更新 |
PUT /api/orders/{unique_key}/shop_memo
|
orders.readorders.update |
| 配送業者 1 件 発送時に指定できる配送業者の一覧。 | ||
| 配送業者一覧取得 |
GET /api/delivery_companies
|
orders.read |
| ファイル 1 件 ファイルのアップロード先の発行。商品画像などファイルを扱う操作の入口。 | ||
| アップロード先発行 |
POST /api/files
|
files.write |
| ユーザー 1 件 認証中のユーザー情報の取得。 | ||
| 認証ユーザーとショップの情報取得 |
GET /api/user
|
user.read |
該当するエンドポイントがありません