BASE API

API リファレンス / 商品

公開状態の切り替え

指定した商品の公開状態を切り替えます。

visible に true を指定すると公開、false を指定すると非公開になります。 切り替え後の visible を返します。

PUT /api/items/{id}/visibility
スコープ items.publishitems.read

リクエスト例

curl 
curl -X PUT "https://apiv2.thebase.com/api/items/123/visibility" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "visible": false
}'

パラメータ

id string · path 必須
商品 ID（1 以上の整数を文字列で表したもの）

リクエストボディ application/json

  • visibleboolean必須
    公開状態の切替先。true=公開化（ショップ画面に表示）/ false=非公開化。

レスポンス

200 切り替え成功。切り替え後の公開状態を返します。

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

  • visibleboolean必須
    切り替え後の公開状態

エラー

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

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

400 /errors/request/malformed-body リクエストボディをこのエンドポイントが要求する形式として解釈できない場合に返します。
400 /errors/items/invalid-body リクエストボディがエンドポイントのスキーマを満たさない場合に返します。
400 /errors/request/invalid-params 1 つ以上のパスパラメータがエンドポイントのスキーマを満たさない場合に返します。
404 /errors/items/not-found 指定した商品が存在しない、または呼び出し元から参照できない場合に返します。1 リクエストで複数の商品を指定するエンドポイント（並び順の変更など）では、そのいずれかが参照できない場合に返します。
413 /errors/request/body-too-large JSON リクエストボディが 1 MiB の上限を超える場合に返します。
415 /errors/request/unsupported-media-type JSON 形式のリクエストボディを要求するエンドポイントに、対応していない Content-Type が指定された、または Content-Type が指定されていない場合に返します。
422 /errors/items/write-rejected 商品の作成・編集・削除を業務ルールにより実行できない場合に返します (型整合性違反、種別不可変、ドメイン制約違反など)。細分化された Problem type に対応しない理由のときに返します。
502 /errors/internal/bad-gateway BASE API が処理を完了するために必要な内部処理で不整合が発生した場合に返します。
504 /errors/internal/gateway-timeout BASE API が処理を完了するために必要な内部処理が制限時間内に完了しなかった場合に返します。