Skip to main content
商品詳細作成
POST

Authorizations

Authorization
string
header
required

APIキーをBearerトークンとして指定

Path Parameters

product_id
string
required

商品ID

Body

application/json

商品詳細作成リクエスト。name / payment_provider / charge_type / amount が必須で、それ以外は省略すると管理画面の作成フォームの初期値が入ります。 真偽値・enum・max_sales_quantity は省略できますが null は指定できません。

name
string
required

名称

Maximum string length: 255
payment_provider
enum<string>
required

決済代行会社。none: なし（bank_transfer のみ） / stripe: Stripe / univapay: UnivaPay / aquagates: AQUAGATES（有効な環境のみ） / telecom: テレコムクレジット / firstpayment: FirstPayment / robotpayment: RobotPayment。bank_transfer は none / univapay のみ

Available options:
none,
stripe,
univapay,
aquagates,
telecom,
firstpayment,
robotpayment
Example:

"stripe"

charge_type
enum<string>
required

支払回数。one_time: 一回払い / multiple: 複数回払い・分割払い / subscription: 継続課金。bank_transfer は one_time のみ

Available options:
one_time,
multiple,
subscription
Example:

"one_time"

amount
integer
required

金額（円・税込）。one_time は決済金額、use_different_first_amount=true のときは初回決済時の金額、multiple + aquagates は決済総額、その他の multiple は1回当たりの金額。stripe + one_time は 50 以上。Stripe はプランの金額と一致させてください

Required range: 0 <= x <= 99999999
payment_type
enum<string>

支払方法。credit_card: クレジットカード払い / bank_transfer: 銀行振込（作成時の省略値は credit_card。null 不可）

Available options:
credit_card,
bank_transfer
Example:

"credit_card"

payment_setting_id
string | null

決済連携設定ID（null・省略はデフォルトの決済連携設定。デフォルトが無い場合は自動作成されます）

is_bump
boolean

オーダーバンプ商品か（作成時の省略値は false＝通常商品）

is_hidden
boolean

連携フォームへの表示（true は表示しない。作成時の省略値は false）。true で保存すると display_name / display_price は null、use_sales_period は false になります

use_different_first_amount
boolean

初回決済時の金額と2回目以降の金額を分けるか（作成時の省略値は false）

recurring_amount
integer | null

2回目以降の金額（円）。stripe + use_different_first_amount=true のとき必須で、amount 以上にします

Required range: 0 <= x <= 99999999
installment_count
integer | null

支払回数・分割回数。charge_type=multiple のとき必須（multiple 以外では null で保存されます）

Required range: 0 <= x <= 999
trial_days
integer | null

無料お試し日数（作成時の省略値は 0）。charge_type=subscription のとき必須。aquagates + subscription は 24 以下（subscription 以外では 0 で保存されます）

Required range: x >= 0
billing_cycle
enum<string>

課金サイクル。month: 毎月 / year: 毎年（作成時の省略値は month。null 不可）

Available options:
month,
year
Example:

"month"

show_payment_count
boolean

分割払いオプション（購入フォームに分割払い回数の選択肢を表示するか。作成時の省略値は false）

stripe_plan_id
string | null

StripeプランのプランID（画面の「Stripeプラン」）。決済連携設定の本番用 Stripe アカウント（本番用シークレットキー）に実在するプラン。stripe + multiple / subscription では stripe_test_plan_id とどちらか一方が必須

Maximum string length: 255
stripe_test_plan_id
string | null

Stripeプラン(テストモード)のプランID。決済連携設定のテスト用 Stripe アカウントに実在するプラン

Maximum string length: 255
telecom_rebill_param_id
string | null

テレコムクレジットの rebill_param_id（telecom + multiple / subscription で使用）

Maximum string length: 255
has_sales_limit
boolean

販売上限を指定するか（作成時の省略値は false）

max_sales_quantity
integer

販売上限数（null 不可）。作成時は has_sales_limit=true なら必須（false で省略すると 0）。更新時は省略すると既存の値を維持します

Required range: x >= 0
display_name
string | null

連携フォームでの商品名表記（null は商品名をそのまま表示）

Maximum string length: 1024
display_price
string | null

連携フォームでの価格表記（null は金額をそのまま表示）

Maximum string length: 1024
use_sales_period
boolean

販売期間を指定するか（作成時の省略値は false）

sales_period_from
string | null

販売期間の開始日時（YYYY-MM-DD HH:mm:ss または YYYY-MM-DD HH:mm。秒は 00 に正規化されます）

sales_period_to
string | null

販売期間の終了日時（YYYY-MM-DD HH:mm:ss または YYYY-MM-DD HH:mm。秒は 59 に正規化されます）

receipt_name
string | null

領収書の品名

Maximum string length: 1024
receipt_description
string | null

領収書の但し書き

Maximum string length: 255
purchase_register_type
enum<string>

購入後（銀行振込は入金反映後）の動作設定「登録するシナリオ」。none: 登録しない / scenario: シナリオに登録 / external_form: 外部連携フォームを利用（作成時の省略値は none）

Available options:
none,
scenario,
external_form
purchase_scenario_id
string | null

購入後に登録するシナリオID。purchase_register_type=scenario のとき必須（それ以外では検証されず無視されます）

purchase_form_id
string | null

購入後に利用する外部連携フォームID（purchase_register_type=external_form のとき使用）

purchase_bundle_id
string | null

購入後に開放するバンドルID（null は開放しない）

purchase_action_id
string | null

購入後に実行するアクション（ファネルアクション）のID（null は実行しない）

registration_register_type
enum<string>

申込後の動作設定「登録するシナリオ」（銀行振込で有効）。none: 登録しない / scenario: シナリオに登録 / external_form: 外部連携フォームを利用（作成時の省略値は none）

Available options:
none,
scenario,
external_form
registration_scenario_id
string | null

申込後に登録するシナリオID。registration_register_type=scenario のとき必須（それ以外では検証されず無視されます）

registration_form_id
string | null

申込後に利用する外部連携フォームID（registration_register_type が external_form 以外では null で保存されます）

registration_action_id
string | null

申込後に実行するアクション（ファネルアクション）のID（null は実行しない）

has_registration_mail
boolean

申込後のメール自動送信（申込受付メール）を送信するか（銀行振込で有効。作成時の省略値は true、bank_transfer + univapay は false）

registration_from_name
string | null

申込受付メールの送信者名。bank_transfer + has_registration_mail=true のとき必須

Maximum string length: 255
registration_from_mail
string | null

申込受付メールの送信者メールアドレス（フリーメール・携帯キャリアメール不可）。bank_transfer + has_registration_mail=true + 送信元 own_domain のとき必須（system では null で保存されます）

Maximum string length: 255
registration_from_address_type
enum<string>

申込受付メールの送信元。own_domain: 独自ドメインのアドレスを利用 / system: システム標準のアドレスを利用（システム標準の送信元が設定された環境のみ。作成時の省略値は own_domain。更新時に省略すると保存されている送信者メールアドレスの有無から復元）

Available options:
own_domain,
system
registration_reply_to_mail
string | null

申込受付メールのお問い合わせ先メールアドレス。bank_transfer + has_registration_mail=true + 送信元 system のとき必須（own_domain では null で保存されます）

Maximum string length: 255
is_registration_custom_mail
boolean

申込受付メールの送信内容をカスタムするか（作成時の省略値は false＝デフォルトの文面）

registration_subject
string | null

申込受付メールの件名。bank_transfer + has_registration_mail=true + is_registration_custom_mail=true のとき必須

Maximum string length: 255
registration_body
string | null

申込受付メールの本文（65,535文字・65,535バイトまで）。bank_transfer + has_registration_mail=true + is_registration_custom_mail=true のとき必須

deadline_days
integer | null

支払い期限（申し込みから何日後か。作成時の省略値は 7）。bank_transfer のとき必須

Required range: 0 <= x <= 32767
has_deadline_mail
boolean

リマインドメールを送信するか（銀行振込で有効。作成時の省略値は true、bank_transfer + univapay は false）

deadline_from_name
string | null

リマインドメールの送信者名。bank_transfer + has_deadline_mail=true のとき必須

Maximum string length: 255
deadline_from_mail
string | null

リマインドメールの送信者メールアドレス（フリーメール・携帯キャリアメール不可）。bank_transfer + has_deadline_mail=true + 送信元 own_domain のとき必須（system では null で保存されます）

Maximum string length: 255
deadline_from_address_type
enum<string>

リマインドメールの送信元。own_domain: 独自ドメインのアドレスを利用 / system: システム標準のアドレスを利用（システム標準の送信元が設定された環境のみ。作成時の省略値は own_domain）

Available options:
own_domain,
system
deadline_reply_to_mail
string | null

リマインドメールのお問い合わせ先メールアドレス。bank_transfer + has_deadline_mail=true + 送信元 system のとき必須（own_domain では null で保存されます）

Maximum string length: 255
is_deadline_custom_mail
boolean

リマインドメールの送信内容をカスタムするか（作成時の省略値は false）

deadline_subject
string | null

リマインドメールの件名。bank_transfer + has_deadline_mail=true + is_deadline_custom_mail=true のとき必須

Maximum string length: 255
deadline_body
string | null

リマインドメールの本文（65,535文字・65,535バイトまで）。bank_transfer + has_deadline_mail=true + is_deadline_custom_mail=true のとき必須

deadline_mail_sent_before_days
integer | null

リマインドメールの送信のタイミング（支払い締切の何日前か。作成時の省略値は 3）。bank_transfer のとき必須

Required range: 0 <= x <= 32767
cancel_unregister_scenario_id
string | null

解除時（継続課金解除時・中途解除時）に解除するシナリオID（null は解除しない）

cancel_register_type
enum<string>

解除時の動作設定「登録するシナリオ」（複数回払い・分割払い・継続課金で有効）。none: 登録しない / scenario: シナリオに登録 / external_form: 外部連携フォームを利用（作成時の省略値は none）

Available options:
none,
scenario,
external_form
cancel_register_scenario_id
string | null

解除時に登録するシナリオID。cancel_register_type=scenario のとき必須（それ以外では検証されず無視されます）

cancel_form_id
string | null

解除時に利用する外部連携フォームID

cancel_bundle_id
string | null

解除時に停止するバンドルID（null は停止しない）

cancel_action_id
string | null

解除時に実行するアクション（ファネルアクション）のID（null は実行しない）

has_failed_mail
boolean

課金失敗時に顧客へメールを送信するか（複数回払い・分割払い・継続課金で有効。作成時の省略値は false）

failed_from_name
string | null

課金失敗メールの送信者名（作成時の省略値はアカウント名）

Maximum string length: 255
failed_from_mail
string | null

課金失敗メールの送信者メールアドレス（メールアドレス形式。作成時の省略値はアカウントのメールアドレス、システム標準の送信元が設定された環境では null）。multiple / subscription + has_failed_mail=true + 送信元 own_domain のとき必須（フリーメール・携帯キャリアメール不可。system では null で保存されます）

Maximum string length: 255
failed_from_address_type
enum<string>

課金失敗メールの送信元。own_domain: 独自ドメインのアドレスを利用 / system: システム標準のアドレスを利用（システム標準の送信元が設定された環境のみ。作成時の省略値は own_domain）

Available options:
own_domain,
system
failed_reply_to_mail
string | null

課金失敗メールのお問い合わせ先メールアドレス（メールアドレス形式）。multiple / subscription + has_failed_mail=true + 送信元 system のとき必須（own_domain では null で保存されます）

Maximum string length: 255
failed_subject
string | null

課金失敗メールの件名（作成時の省略値は既定の件名）

Maximum string length: 255
failed_body
string | null

課金失敗メールの本文（65,535文字・65,535バイトまで。作成時の省略値は既定の本文）

has_purchase_mail
boolean

購入後のメール自動送信（顧客向けの購入後メール。管理者向けの通知設定とは別）を送信するか（作成時の省略値は false）

purchase_from_name
string | null

購入後メールの送信者名。has_purchase_mail=true のとき必須

Maximum string length: 255
purchase_from_address_type
enum<string>

購入後メールの送信元。own_domain: 独自ドメインのアドレスを利用 / system: システム標準のアドレスを利用（システム標準の送信元が設定された環境のみ。作成時の省略値は own_domain）

Available options:
own_domain,
system
purchase_from_mail
string | null

購入後メールの送信者メールアドレス（フリーメール・携帯キャリアメール不可）。has_purchase_mail=true + 送信元 own_domain のとき必須（system では null で保存されます）

Maximum string length: 255
purchase_reply_to_mail
string | null

購入後メールのお問い合わせ先メールアドレス。has_purchase_mail=true + 送信元 system のとき必須（own_domain では null で保存されます）

Maximum string length: 255
is_purchase_custom_mail
boolean

購入後メールの送信内容をカスタムするか（作成時の省略値は false＝デフォルトの文面）

purchase_subject
string | null

購入後メールの件名。has_purchase_mail=true + is_purchase_custom_mail=true のとき必須

Maximum string length: 255
purchase_body
string | null

購入後メールの本文（65,535文字・65,535バイトまで）。has_purchase_mail=true + is_purchase_custom_mail=true のとき必須

notify_mail
string | null

通知設定の通知先メールアドレス（購入通知の送信先。カンマ区切りで複数指定可。作成時の省略値はアカウントのメールアドレス。null は通知しない）

Maximum string length: 2048
is_purchase_custom_notify
boolean

購入通知の通知内容をカスタムするか（作成時の省略値は false）

purchase_custom_notify_subject
string | null

購入通知の件名（カスタム時）

Maximum string length: 1024
purchase_custom_notify_body
string | null

購入通知の本文（カスタム時。65,535文字・65,535バイトまで。置き換え文字を利用できます）

chat_notify_type
enum<string>

チャット通知の通知先。none: 通知しない / chatwork: Chatwork / slack: Slack / discord: Discord（作成時の省略値は none）

Available options:
none,
chatwork,
slack,
discord
chat_notify_token
string | null

Chatwork の APIトークン、または Slack の Bot User OAuth Token（設定専用。応答には含まれません。更新時に省略すると既存値を維持、null でクリア）

Maximum string length: 255
chat_notify_webhook_url
string | null

Discord のウェブフックURL（URL形式。設定専用。応答には含まれません。更新時に省略すると既存値を維持、null でクリア）

Maximum string length: 255
chat_notify_to
string | null

チャット通知の通知先（Slack はチャンネル名、Chatwork はルームID）

Maximum string length: 255
is_chat_custom_notify
boolean

チャット通知の通知内容をカスタムするか（作成時の省略値は false）

chat_notify_text
string | null

チャット通知の内容（カスタム時。65,535文字・65,535バイトまで）

Response

作成された商品詳細

data
object

商品詳細の全項目。管理画面「商品詳細管理」の設定画面の内容です。chat_notify_token / chat_notify_webhook_url は設定専用のため含まれません。 各メールの *_from_address_type は保存されず、保存されている送信者メールアドレス（*_from_mail）の有無から復元します（システム標準の送信元が設定された環境で空なら system、それ以外は own_domain）。