BASE API

BASE API β版

BASE の商品や在庫、注文を管理するための API です。 外部システムとのデータ連携や、ショップの運営業務の自動化に利用できます。

β版のため、正式リリースまでに API の仕様が変更、調整される可能性があります。

クイックスタート

BASE API の利用には、BASE のアカウントが必要です。

Personal Access Token（PAT）を使って、アカウント情報とショップ情報を取得します。

  1. BASE Developers で、user.read スコープを持つ Personal Access Token を発行します。
  2. 次の例の <your-token> をトークンに置き換え、リクエストを送信します。
curl -H "Authorization: Bearer <your-token>" \
  https://apiv2.thebase.com/api/user

成功すると 200 OK とともに、アカウント情報とショップの名称・公開 URL などを JSON 形式で返します。 レスポンスの各項目は 認証ユーザーとショップの情報取得で確認することができます。

基本仕様

API URL https://apiv2.thebase.com
認証

Authorization ヘッダーに Bearer <token> の形式で PAT を指定します。

β版では OAuth フローを提供しません。
スコープ

各エンドポイントの利用には、その操作が要求するスコープが必要です。 権限の考え方と一覧はスコープで確認することができます。

リクエスト

パスやクエリに指定するパラメータは、各エンドポイントの定義に従います。 JSON のリクエストボディを送信する場合は、Content-Type: application/json を指定します。

レスポンス

データは JSON 形式で返します。204 No Content の場合はレスポンスボディを返しません。 成功時のステータスコードとデータの構造は、各エンドポイントに記載しています。

エラー時は HTTP ステータスコードと、Problem Details 形式の JSON を返します。 エラーの構造と種別はエラーレスポンスで確認することができます。

API リファレンス

操作するデータから、エンドポイントを探すことができます。

v1 API からの移行

v1 API を利用している場合は、移行ガイドで 認証方式やエンドポイント、フィールドの変更点を確認することができます。

今後の開発ロードマップ

2026 年末に予定している正式リリースに合わせて、次の機能を提供する予定です。

v1 の商品検索 API（GET /1/items/search）に相当する API の提供予定はありません。