API リファレンス / 商品

商品編集

リクエスト例

curl -X POST "https://apiv2.thebase.com/api/items/123" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "item_tax_type": "standard",
  "detail": "string",
  "identifier": "string",
  "price": 50,
  "quantity_limit": 1,
  "subscription": {},
  "lottery": {}
}'

パラメータ

リクエストボディ application/json

• namestring任意1 文字以上 / 255 文字以下
  商品名（1〜255 文字）。絵文字などの 4 バイト文字は使用できません。
• item_tax_typeItemTaxType任意
  税区分。standard=標準税率、reduced=軽減税率。
• detailstring任意nullable65535 文字以下
  商品説明文（最大 65535 文字）。絵文字などの 4 バイト文字は使用できません。null を指定すると値をクリアします。
• identifierstring任意nullable50 文字以下 / pattern: ^[a-zA-Z0-9_-]+$
  商品コード（最大 50 文字）。半角英数字と「_」「-」のみ指定できます。null を指定すると値をクリアします。
• priceinteger任意≥ 50 / ≤ 100000000
  販売価格（税込、円、50〜100000000 円）。ショップの設定により上限が異なります。割引は別の sale エンドポイントで設定します。送信すると、適用中のセール割引が解除され、proper_price は null になります。
• quantity_limitinteger任意nullable≥ 1 / ≤ 100
  同時購入数の上限（1〜100）。null を指定すると値をクリアします。
• subscriptionItemSubscriptionEdit任意
  定期便のリピート時の価格・リピート回数・課金周期。送らなかったフィールドは変更しません。type=subscription のときのみ指定できます。
  • repeat_priceinteger任意≥ 50 / ≤ 100000000
    継続サイクルの販売価格（税込、円、50〜100000000 円）。ショップの設定により上限が異なります。省略時は商品本体価格と同額になり、初回・継続の価格が同じになります。
  • repeat_timesItemSubscriptionRepeatTimes任意
    リピート回数。repeat_3_times / repeat_6_times / repeat_12_times は指定回数で終了し、unlimited は停止されるまで継続します。
  • cycle_planItemSubscriptionCyclePlan任意
    課金周期。weekly=毎週、every_2_weeks=隔週、monthly=毎月、every_45_days=45日ごと、every_2_months=隔月、every_3_months=3ヶ月ごと。
• lotteryobject任意
  抽選販売の応募期間・当落通知予定日時。送らなかったフィールドは変更しません。type=lottery のときのみ指定できます。
  • application_start_atstring (date-time)任意
    応募開始日時（ISO 8601・UTC）
  • application_end_atstring (date-time)任意
    応募終了日時（ISO 8601・UTC）
  • scheduled_announce_atstring (date-time)任意
    当落通知予定日時（ISO 8601・UTC）

レスポンス

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

• item_idinteger必須≥ 0
  作成・更新された商品の ID

エラー

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

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