# BASE API

> BASE のショップデータにアクセスするための API です。アイテムや在庫、注文などをプログラムから操作できます。

各ページは HTML の URL 末尾の `/` を `.md` に変えた URL で Markdown 版を取得できます（例: `/docs/scopes/` → `/docs/scopes.md`）。

## ドキュメント

- [ホーム](/docs/index.md): API の概要とはじめかた
- [API リファレンス](/docs/reference.md): エンドポイントの一覧と、それぞれが要求するスコープ
- [スコープ](/docs/scopes.md): アクセストークンの権限の考え方と、利用可能なスコープ一覧
- [エラーレスポンス](/docs/errors.md): エラーの構造（Problem 形式）と、エラー種別の一覧
- [v1 API からの移行](/docs/migration.md): 従来の `/1/` 系 API からの移行ガイド。エンドポイントとフィールドの対応表

## 商品

- [GET /api/items](/docs/endpoints/get-api-items.md): 商品一覧取得
- [POST /api/items](/docs/endpoints/post-api-items.md): 商品作成
- [GET /api/items/{id}](/docs/endpoints/get-api-items-id.md): 商品詳細取得
- [POST /api/items/{id}](/docs/endpoints/post-api-items-id.md): 商品編集
- [DELETE /api/items/{id}](/docs/endpoints/delete-api-items-id.md): 商品削除
- [GET /api/items/{id}/variations](/docs/endpoints/get-api-items-id-variations.md): 種類一覧取得
- [POST /api/items/{id}/variations](/docs/endpoints/post-api-items-id-variations.md): 種類追加
- [PUT /api/items/{id}/variations](/docs/endpoints/put-api-items-id-variations.md): 種類の並び替え
- [POST /api/items/{id}/variations/{variation_id}](/docs/endpoints/post-api-items-id-variations-variation-id.md): 種類編集
- [DELETE /api/items/{id}/variations/{variation_id}](/docs/endpoints/delete-api-items-id-variations-variation-id.md): 種類削除
- [PUT /api/items/{id}/stock](/docs/endpoints/put-api-items-id-stock.md): 在庫設定
- [GET /api/items/{id}/images](/docs/endpoints/get-api-items-id-images.md): 画像一覧取得
- [POST /api/items/{id}/images](/docs/endpoints/post-api-items-id-images.md): 画像追加
- [PUT /api/items/{id}/images](/docs/endpoints/put-api-items-id-images.md): 画像の並び替え
- [DELETE /api/items/{id}/images/{image_id}](/docs/endpoints/delete-api-items-id-images-image-id.md): 画像削除
- [PUT /api/items/{id}/visibility](/docs/endpoints/put-api-items-id-visibility.md): 公開状態の切り替え
- [PUT /api/items/{id}/list_order](/docs/endpoints/put-api-items-id-list-order.md): 並び順の変更

## 商品カテゴリ

- [GET /api/item_categories](/docs/endpoints/get-api-item-categories.md): カテゴリ一覧取得
- [POST /api/item_categories](/docs/endpoints/post-api-item-categories.md): カテゴリ作成
- [GET /api/item_categories/{id}](/docs/endpoints/get-api-item-categories-id.md): カテゴリ取得
- [POST /api/item_categories/{id}](/docs/endpoints/post-api-item-categories-id.md): カテゴリ編集
- [DELETE /api/item_categories/{id}](/docs/endpoints/delete-api-item-categories-id.md): カテゴリ削除
- [PUT /api/item_categories/{id}/list_order](/docs/endpoints/put-api-item-categories-id-list-order.md): カテゴリの並び順を変更する
- [PUT /api/item_categories/{id}/items/{item_id}](/docs/endpoints/put-api-item-categories-id-items-item-id.md): カテゴリに商品を追加
- [DELETE /api/item_categories/{id}/items/{item_id}](/docs/endpoints/delete-api-item-categories-id-items-item-id.md): カテゴリから商品を削除

## 注文

- [GET /api/orders/{unique_key}](/docs/endpoints/get-api-orders-unique-key.md): 注文取得
- [PUT /api/orders/{unique_key}](/docs/endpoints/put-api-orders-unique-key.md): 注文内容更新
- [POST /api/orders/search](/docs/endpoints/post-api-orders-search.md): 注文検索
- [POST /api/orders/{unique_key}/cancel](/docs/endpoints/post-api-orders-unique-key-cancel.md): 注文キャンセル
- [POST /api/orders/{unique_key}/dispatch](/docs/endpoints/post-api-orders-unique-key-dispatch.md): 注文発送
- [PUT /api/orders/{unique_key}/customer](/docs/endpoints/put-api-orders-unique-key-customer.md): 注文メールアドレス更新
- [PUT /api/orders/{unique_key}/shipping](/docs/endpoints/put-api-orders-unique-key-shipping.md): 注文配送先更新
- [PUT /api/orders/{unique_key}/delivery](/docs/endpoints/put-api-orders-unique-key-delivery.md): 注文配送希望日時更新
- [PUT /api/orders/{unique_key}/shop_memo](/docs/endpoints/put-api-orders-unique-key-shop-memo.md): 注文ショップメモ更新

## 配送業者

- [GET /api/delivery_companies](/docs/endpoints/get-api-delivery-companies.md): 配送業者一覧取得

## ファイル

- [POST /api/files](/docs/endpoints/post-api-files.md): アップロード先発行

## ユーザー

- [GET /api/user](/docs/endpoints/get-api-user.md): 認証ユーザーとショップの情報取得