API リファレンス / ユーザー

認証ユーザーとショップの情報取得

リクエスト例

curl -X GET "https://apiv2.thebase.com/api/user" \
  -H "Authorization: Bearer <your-token>"

レスポンス

200 のレスポンスボディ（application/json）:

• shop_idstring必須
  ショップ識別子。ショップごとに一意の文字列です。
• shop_urlstring (uri)必須
  ショップの公開 URL。独自ドメインを設定していればそのドメイン、していなければ BASE が提供するドメインになります。
• mail_addressstring (email)必須
  ログインに使うメールアドレス
• nicknamestring必須nullable
  ニックネーム。未設定時は null です。
• shop_namestring必須
  ショップ名。未設定の場合は空文字列を返します。
• shop_introductionstring必須nullable
  ショップ紹介文。利用者入力をそのまま返すため利用側で必ずエスケープしてください。未設定時は null です。
• shop_categoryNullableShopCategory必須nullable
  ショップが選択しているカテゴリ。最大 3 階層（大 / 中 / 小）の選択式で、選んでいない場合は null です。
  • largestring必須
    大カテゴリの表示名
  • middlestring必須nullable
    中カテゴリの表示名。中カテゴリまで選んでいない場合は null です。
  • smallstring必須nullable
    小カテゴリの表示名。小カテゴリまで選んでいない場合は null です。
• able_to_businessboolean必須
  ショップが公開中かどうか。false の間は商品ページが公開されません。
• using_only_cartboolean必須
  カート専用モードかどうか。true のときは、自前サイトに BASE のカートのみを埋め込んで利用する形態です。
• default_item_tax_type"standard" | "reduced"必須
  新規商品作成時に適用するデフォルト税率。standard=標準税率, reduced=軽減税率
• external_service_accountUserExternalServiceAccount必須
  • twitterstring必須nullable
    X (旧 Twitter) のアカウント識別子。サービス側の表現に従い、@ つきハンドル等の文字列が入る場合があります。未連携時は null です。
  • facebookstring必須nullable
    Facebook のアカウント識別子。未連携時は null です。
  • amebastring必須nullable
    Ameba のアカウント識別子。未連携時は null です。
  • instagramstring必須nullable
    Instagram のアカウント識別子。未連携時は null です。
  • linestring必須nullable
    LINE@ のアカウント識別子。未連携時は null です。
  • youtubestring必須nullable
    YouTube のアカウント識別子。未連携時は null です。
  • notestring必須nullable
    note のアカウント識別子。未連携時は null です。
  • tiktokstring必須nullable
    TikTok のアカウント識別子。未連携時は null です。

エラー

エラーは application/problem+json の Problem 形式で返します。 認証・スコープ・予期しない内部エラーなど、すべてのエンドポイントに共通のエラーと 構造・判別方法は エラーレスポンス を参照してください。

このエンドポイントが返すその他のエラーは次のとおりです。