現在の「楽楽販売」のAPI連携の仕様では、レコード登録APIのリクエストパラメータにおいて、関連マスタから従属項目を自動取得する設定("getSubordinate": "1")を有効にしている場合、リクエスト内容(values内)に含まれる従属項目への値指定は受け付けられない仕組みとなっています。
この自動取得が有効な状態で、valuesパラメータ内に従属項目の値を指定して送信すると、システムの整合性を保つための制限バリデーションにより、以下のエラーが発生してレコードの登録処理全体が強制ロールバック(失敗)されます。
そのため、特定の従属項目にのみ外部システムから独自の文言を上書きして登録したい場合は、お手数をおかけしますが、以下の代替案による連携プログラムの設計・構築をご検討ください。
自動取得機能の稼働と任意値の直接指定を1回のリクエストで共存させることはできませんが、APIのパラメータ指定方法や実行手順を工夫することで、安全に目的のデータ登録を実現することが可能です。
「楽楽販売」側での自動取得に頼らず、連携元の外部システム(kintone、基幹システム、連携ツールなど)側で、マスタから引用する値と独自に上書きしたい値をあらかじめすべてマージ・構築してから送信する方法です。
【設定・実行手順】:
1. レコード登録APIのリクエストパラメータにて、"getSubordinate": "0" を明示的に指定します(またはパラメータ自体を記述しない)。
2. 外部システム側のプログラムにて、対象レコードの「DBリンク項目」に紐づくすべての従属項目の値を事前に準備します。
3. 上書きしたい従属項目には独自の文言を、それ以外の従属項目にはマスタから取得した値をセットし、一つのJSON valuesパラメータとして「楽楽販売」へ送信します。
※この方法は、すべての従属項目の値を外部から明示的に引き渡す必要があるため、外部システム側でマスター情報を一時的、または永続的に保持・参照できる開発環境に適しています。
「楽楽販売」のマスタ自動取得機能を活かしつつ、登録後に特定の項目だけを任意の外部データで修正する方法です。
【設定・実行手順】:
◆1回目:レコード登録APIの実行(新規追加)
・パラメータを "getSubordinate": "1" に設定し、マスタに紐づくDBリンク項目(キー値)を指定してリクエストを投げます。
・これにより、すべての従属項目が「楽楽販売」内のマスタデータに基づいて自動的に入力された状態でレコードが新規作成されます。
◆2回目:レコード更新APIの実行(値の書き換え)
・1回目の登録成功レスポンスから作成されたレコードのIDを取得し、そのIDを更新キー("id" または "keyId")に指定します。
・パラメータは "getSubordinate": "0" を指定し、上書きしたい特定の従属項目に対してのみ、外部システムから任意の値を values に格納してリクエストを送信します。従属項目は一度データベースに登録されれば、通常のテキスト項目や数値項目と同様に自由に上書き更新が可能です。
※この方法は、APIを複数回連続して実行(シーケンシャル処理)できるプログラム構成である場合に有効な回避策となります。
業務データベース ➔ マスタデータベース ➔ 親マスタデータベース のように、従属項目を数珠繋ぎ(ネスト)にして2段階以上遡ってデータをコピーする設定をデータベース(データベース)側に施している場合、レコード登録APIにおける自動従属取得は「直近の1階層目(子の従属項目)」しか自動実行されません。
2階層目以降(孫の従属項目)はAPI実行時には完全に無視され、空欄(値なし)のままレコードが登録されます。 ネスト構造の従属項目がある場合は、アプローチAで外部からすべて値を指定して送信するか、手動で一括再取得を行う設計にしてください。
楽楽販売のデータベース項目設定で、対象項目に「初期値(デフォルト値)」を定義していても、APIでのレコード登録時にはその設定は適用されず、送信データに含めない限り空欄(null)として処理されます。
そのため、必須項目だからと「初期値が設定してあるから大丈夫だろう」とAPIの values パラメータから除外して送信すると、「'○○'を入力してください。(エラーコード100)」というパラメータ不正エラーが発生し、登録全体が失敗します。
API実行時は、必須項目にはすべて明示的に値を直接指定してリクエストを送信してください。
「楽楽販売」はお客様から頂戴したご意見・ご要望をもとに、
よりよく、寄り添う 販売管理クラウドを目指してまいります。
現在の仕様ではご希望の機能に対応しておりませんが、
お客様からの貴重なご意見として真摯に受け止め、今後の改善に役立ててまいります。
APIを利用したデータの登録・更新に関する詳細仕様、およびエラー発生時の詳細な解決手順については、サクセスナビの下記記事をご確認ください。
外部システムから「楽楽販売」へAPI(POSTメソッド)を投げる際のURL形式、認証ヘッダ(X-HD-apitoken)の記述方法、JSONパラメータの構成規則、および送信可能なデータ型の詳細を解説しています。
API連携オプション:設定方法
(記事ID:2940)