API連携でDBリンク項目や選択肢項目に値を指定してレコードを登録する方法

「楽楽販売」のAPI連携において、DBリンク項目や選択肢項目へ値を登録するには、各項目の「キー項目」または「選択肢の値」をパラメータとして指定する必要があります。

「楽楽販売」のAPI連携（レコード登録API・レコード更新API等）では、データベースの項目タイプごとに指定すべき値の形式が決まっています。

特にDBリンク項目や選択肢項目は、画面上の表示名ではなく、システム内部で管理されている「キー項目」や「選択肢の文字列」を正確に指定しないと、データ不整合防止の仕様によりエラーが発生して登録・更新ができません。

1. DBリンク項目へ値を登録する方法

DBリンク項目は、リンク先データベースの「キー項目」の値を指定することで紐付けを行います。画面上の表示名（顧客名など）を直接入力しても登録できません。

【設定手順】
APIリクエストの values パラメータにて、DBリンク項目の項目IDをキーとし、値（Value）にはリンク先データベースの「キー項目」の値を指定してください。
※リンク先データベースのキー項目が「自動採番」の場合も、その採番された文字列（例：C-00001 など）を指定します。

2. 選択肢項目へ値を登録する方法

選択肢項目は、項目設定画面で登録されている「選択肢の文字列」と完全一致する値を指定する必要があります。

【設定手順】
APIリクエストの values パラメータにて、選択肢項目の項目IDをキーとし、値（Value）には「選択肢として登録されている文字列」をそのまま指定してください。
※全角・半角、大文字・小文字、スペースの有無も厳密に判定されます。項目設定画面で登録されている選択肢と一字一句違わないように指定してください。
※「選択肢（複数選択）」項目の場合は、配列形式（例：["選択肢A", "選択肢B"]）で値を送信します。

3. API連携時の注意点（初期値・必須項目の挙動）

API経由でのレコード作成・更新では、楽楽販売の画面設定（項目設定・メニュー設定）で指定している「初期値」や「強制登録」の設定は適用されません。

• 必須項目の場合： パラメータに値を含めない場合や、空（null）のまま送信すると必須チェックエラー（エラーコード100 等）が発生します。
• 任意項目の場合： 初期値が設定されている項目であっても、パラメータを省略すると初期値はセットされず「空欄（null）」で登録されます。

そのため、必須項目はもちろん、初期値をセットして登録したい項目についても、必ずAPIリクエストデータ内に値を指定して送信してください。

関連記事

API連携の詳細な仕様や、エラーが発生した場合の対処方法については下記記事をご確認ください。

API連携オプション：設定方法

API連携の接続先URLや、リクエストパラメータの構成規則について詳しく解説しています。
API連携オプション：設定方法

エラー「'〇〇'に入力された値は、リンク先のDBのキー項目として使用されていません。」と表示された

DBリンク項目に誤った値や存在しないキーを指定した場合の対処方法について解説しています。
エラー「'〇〇'に入力された値は、リンク先のDBのキー項目として使用されていません。」と表示された

エラー「'【〇〇】'に入力されたデータは選択肢に存在しません。」と表示された

選択肢項目に登録されていない値（表記揺れ等）を指定した場合の対処方法について解説しています。
エラー「'【〇〇】'に入力されたデータは選択肢に存在しません。」と表示された

（記事ID：3009）