BASE API v2 β版

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

β版のため、v2 の仕様は予告なく変更されることがあります。セキュリティ対応や機能の更新のために、予告なくメンテナンスを行ったり、互換性のない変更を加えたりすることもあります。β版について詳しくはよくある質問で確認することができます。

クイックスタート

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

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

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 を指定します。 PAT には発行時に有効期限が設定され、期限を過ぎたトークンでのリクエストには 401（`/errors/auth/unauthenticated`）を返します。有効期限は発行後に変更できないため、期限が切れる前に新しい PAT を発行して差し替える必要があります。各 PAT の有効期限は BASE Developers で確認することができます。 β版では OAuth フローを提供しません。
スコープ	各エンドポイントの利用には、その操作が要求するスコープが必要です。権限の考え方と一覧はスコープで確認することができます。
リクエスト	パスやクエリに指定するパラメータは、各エンドポイントの定義に従います。 JSON のリクエストボディを送信する場合は、`Content-Type: application/json` を指定します。
レスポンス	データは JSON 形式で返します。`204 No Content` の場合はレスポンスボディを返しません。成功時のステータスコードとデータの構造は、各エンドポイントに記載しています。エラー時は HTTP ステータスコードと、Problem Details 形式の JSON を返します。エラーの構造と種別はエラーレスポンスで確認することができます。

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

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

正式リリースは 2026 年末を目標に開発を進めています。次の機能は、正式リリースを待たずに準備ができたものから順に提供し、すべて揃った時点で正式リリースとします。提供を始めた機能や、目標の時期が変わる場合のお知らせは、このページと変更履歴に載せます。

β版ではリクエスト数に上限を設けていませんが、正式リリースに向けて上限を設けます。上限値は導入の前にお知らせします。

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