API連携オプションがうまくいかない　記事一覧

エラー原因と対処法（例）

1.SSLクライアント証明書が連携されていない

SSLクライアント認証オプションをご契約中の環境に対して連携を行う場合、
プログラム側に証明書を付加してアクセスするよう設定が必要となります。

SSLクライアント認証利用時のサンプルプログラムをご用意しておりますので、
設定内容をご確認ください。

API連携オプション設定マニュアルより、添付資料をダウンロードしてください。

2.タイムアウトエラーが発生している

連携先システムで利用しているプログラムのタイムアウト時間が短い場合、
「楽楽販売」側での処理時間が想定よりもかかった際に
タイムアウトエラーとなる場合がございます。

利用しているプログラム側のタイムアウト時間を調整ください。
※通常は数秒で処理結果を返却しますが、実行タイミングや時間帯によっては
　数十秒程度時間がかかる場合がございます。

3.連携先システム側でエラーが発生している

連携先システムにて何らかのエラーが発生し、
処理が正常に完了しなかった可能性が考えられます。
連携先システム側でエラーが発生していないかご確認ください。

（記事ID：2253）

エラー原因と対処法（例）

API連携のIPアクセス制限が設定されていない、またはIPアドレスが誤っている

「外部システム ⇒ 楽楽販売」の連携にあたっては、
あらかじめ「楽楽販売」にて連携先システムのIPアドレスの登録が必要です。

以下よりIPアドレスの設定があるか、また登録したIPアドレスに
誤りがないかご確認くださいませ。

【設定箇所】
　管理者設定＞セキュリティ設定タブ＞IPアクセス制限に関する設定

• 「APIのアクセス制限」にアクセスを許可する連携先システムの
  IPアドレスを指定してください。

 （記事ID：2251）

エラー原因と対処法（例）

1.パラメータ名のスペルが誤っている

• 指定したパラメータ名のスペルが誤っている可能性が考えられます。
• 大文字／小文字の違いによってもエラーとなるため
  パラメータ名に誤りがないかご確認ください。
  【例】×：KeyId　→　○：keyI

2.パラメータに指定する値が誤っている

以下のような原因が考えられます。

• 存在しない値（DBリンク）や選択肢が指定されている
• 指定するIDとパラメータが合致していない
  【例】パラメータ「id」に対してキー項目の値が渡されている、など
• 指定された入力条件に合致していない
  【例】項目設定などで指定した必須設定や入力制限・入力形式に
  　　　合致しない値が渡されている　など
  
  

3.パラメータの指定形式が誤っている

• 指定形式がJSON形式になっていない
• リクエストヘッダの設定に不備がある
  【例】「Content-Type」が「multipart」だが「boundary」が設定されていない　など

（記事ID：2249）

エラー原因と対処法（例）

1.APIトークンが設定されていない

「外部システム ⇒ 楽楽販売」の連携にあたっては
認証用キーとして「APIトークン」の指定が必要です。
以下よりAPIトークンを生成し連携を行ってください。

【APIトークン生成箇所】
　管理者設定＞ユーザ設定タブ＞ユーザ管理＞設定

• APIトークン欄の[生成]リンクをクリックし、APIトークンを生成。
• 生成後、[確定]ボタンをクリックすることで、APIトークンが有効となります。

2.APIトークンが誤っている

以下のような原因が考えられます。
ユーザ設定からAPIトークンの値を確認し、
指定したAPIトークンが誤っていないかご確認ください。

• APIトークンの再生成をされており、リクエストの値を変更していない。
• APIトークン生成（再生成）後、「確定」ボタンを押していない。
  「確定」ボタンを押さないと生成されたAPIトークンが有効となりません。
  
  

3.APIトークンの指定方法が誤っている

APIトークンをプログラム側で正しく連携できていない可能性が考えられます。
リクエストで連携しているAPIトークンの設定内容をご確認ください。

4.連携先システム側で接続できない状態となっている

連携先システム側で何らかの原因で接続できない状態となっている可能性がございます。
連携先システム側の設定や接続状況をご確認ください。
【例】連携先システムのAPIが開放されていない　など

（記事ID：2250）

エラー原因と対処法（例）

1.実行するURLが誤っている

以下のような原因が考えられます。
実行しているURLを確認し、形式やスペルなど設定の誤りがないかご確認ください。

• 実行するURLにてAPIの指定が漏れている
• 実行するURLのスペルが誤っている

接続先URLの指定形式
https://【ドメイン】/【アカウント】/api/【実行するAPI】/version/【APIバージョン】

詳細はAPI連携オプション設定マニュアルのリクエスト方式＞URLをご確認くださいませ。

2.連携されたデータに不備がある

以下のような原因が考えられます。
連携先システムから連携されたデータに不備がないかご確認くださいませ。

• 連携されたデータ（ファイルなど）が壊れている
• 0バイトのファイルを送信している
• 特殊な文字種を使用している

（記事ID：2252）

外部システムから「楽楽販売」のデータを取得するには、CSVエクスポートAPIに対してAPIトークン認証を用いたPOSTリクエストを実行することで設定可能です

「楽楽販売」のAPI連携オプションを利用することで、手動でのCSVエクスポート操作を介さずに、外部システム（基幹システムなど）から直接データを抽出・連携できるようになります。

これにより、バックアップ取得の自動化やシステム間のデータ同期の工数を大幅に削減し、データの正確性を保つことが可能です。

接続に必要なエンドポイントURL・HTTPメソッド・認証方式の仕様

CSVエクスポートAPIを実行するための基本情報は以下の通りです。接続先のURLは、ご利用中の環境ごとに固有のドメイン（サーバー名）とアカウント名（スキーマ名）を含める必要があります。

• エンドポイントURL：
  https://【ドメイン】/【アカウント】/api/csvexport/version/v1
• HTTPメソッド： POST
• 認証方式： APIトークン認証（HTTPヘッダに指定）
• HTTPヘッダ設定：
  Content-Type: application/json; charset=utf-8
  X-HD-apitoken: [発行したAPIトークン]

外部システムから送信するリクエストパラメータの設定例（JSON形式）と各項目の意味

リクエストのボディには、取得対象のデータベースや抽出条件を特定するためのパラメータをJSON形式で記述します。一度に取得する件数（limit）や開始位置（offset）を指定することで、大量のデータを分割して安全に取得することも可能です。

{
"dbSchemaId": "101406",
"searchId": "100809",
"listId": "100001",
"limit": 200,
"offset": 0
}

【各パラメータの解説】

• dbSchemaId： 対象データベースのIDです。
• searchId： 抽出に使用する「絞込み設定」のIDです。
• listId： 出力形式（列の並び順）を規定する「レコード一覧画面設定」のIDです。※指定しない場合は「ID」の降順かつ、一覧表示が「すべて」の初期項目でエクスポートされます。
• limit： 一度にエクスポートするレコード件数です（※上限値はプランによって厳格に異なります）。
• offset： データの取得開始位置（スキップ行数）です。

【APIトークン発行】と【APIアクセス制限（IP登録）】の手順

APIを実行するためには、操作を行うユーザーに紐づく「APIトークン」を事前に発行することに加え、送信元の接続グローバルIPアドレスをシステムに登録しておくことが必要です。

手順1：ユーザー管理画面から「APIトークン」を発行する

【設定箇所】 管理者設定＞ユーザー設定＞ユーザー管理

1. ユーザー一覧より、APIトークンを発行する対象ユーザー（セキュリティのため、API連携専用ユーザーの作成を強く推奨します）の「設定」ボタンをクリックします。
2. 「APIトークン」欄にある「生成」リンクをクリックします。
3. ランダムな文字列（トークン）が生成されるので、内容をコピーして控えておきます。
4. 画面下部の「確定」ボタンをクリックします。※「確定」を押さないと、生成されたトークンが有効になりませんのでご注意ください。

手順2：APIのアクセス制限（接続元IPアドレス登録）を登録する

【設定箇所】 管理者設定＞セキュリティ設定＞IPアクセス制限に関する設定

1. セキュリティの共通仕様として、「IPアドレス制限サービス」オプションの契約有無にかかわらず、APIを利用する際はアクセス元のグローバルIPアドレス登録が100%必須です。
2. 「APIのアクセス制限」欄に、リクエストを送信してくる外部システムサーバー等のグローバルIPアドレスを入力し、「確定」をクリックします。未登録のIPからのリクエストは、トークンが正しくてもすべて「403 Forbidden（アクセスが拒否されました）」として強制遮断されます。

URLの構成要素である「ドメイン」と「アカウント」を確認する方法

エンドポイントURLを作成する際に必要となる「ドメイン」と「アカウント」は、普段ログインに使用しているブラウザのURLから確認できます。

【確認例】
ログインURLが https://sv01.rakurakuhanbai.jp/sample_ac/top/main の場合

• ドメイン： sv01.rakurakuhanbai.jp （サーバー名を含むドメイン）
• アカウント：  sample_ac （ドメインの直後のスラッシュに続く文字列※ログインIDではありません）

お問い合わせフォームよりご要望をお寄せください。

「楽楽販売」はお客様から頂戴したご意見・ご要望をもとに、
よりよく、寄り添う 販売管理クラウドを目指してまいります。

現在の仕様ではご希望の機能に対応しておりませんが、
お客様からの貴重なご意見として真摯に受け止め、今後の改善に役立ててまいります。

関連マニュアル

詳細な仕様の違いや作成手順については、サクセスナビの下記記事をご確認ください。

API連携の全体的な設定方法と仕様書

外部システムとの連携設定手順書（PDF）をダウンロードできます。
API連携オプション：設定方法

APIトークンの具体的な発行手順

ユーザーごとにAPIトークンを生成・確定して安全に管理・利用する方法について解説しています。
API連携オプション：APIトークンの発行方法

サーバー名やURLアカウント（スキーマ）の確認方法

ご利用中の環境のドメインURLや、アカウント情報（スキーマ名）の確認方法、ログインIDとの違いについて解説しています。
「楽楽販売」の現在のバージョン／サーバー名の確認方法

API連携において1回あたりの上限（200件／10,000件）を超えるデータを連携したい場合

プランごとのエクスポート容量上限（2MB／10MB）やリクエスト数制限（20回／50回）、offsetとlimitパラメータを用いた具体的な分割取得・連結ループプログラムの設計パターンについて詳しく解説しています。
API連携オプション：リクエスト上限の回避方法

（記事ID：2922）

CSVエクスポートAPIで、メニューに設定された複数の「絞り込み設定」を同時に呼び出すことはできません

現在の「楽楽販売」の仕様では、CSVエクスポートAPI（csvexport）を実行する際、パラメータの "searchId"（絞り込み設定ID）に指定できるIDは、リクエスト1回につき「1つ（単一の数値）」のみです。

そのため、レコード一覧タイプのメニューに設定されている「絞り込み設定1〜9」といった、すでに画面上で個別に分離して定義されている複数の絞り込み設定を、配列指定などでAPI経由で一度に同時に適用してデータを取得する機能はありません。

ただし、「複数の絞り込み条件（AND/OR結合）に合致するデータをAPIで一度に取得したい」という目的は、楽楽販売側の設定を工夫することで、対応が可能です。

複雑な複数条件に合致するデータをAPIで取得するための代替案

1つの「絞り込み設定（searchId）」に複数の条件を集約（グループ化）して定義する

「複数の絞り込み設定IDを同時にAPIで指定する」ことはできませんが、「1つの絞り込み設定（1つのsearchId）の内部に、複数の検索条件をANDやORで結合・グループ化して一元的に定義しておくこと」は、楽楽販売の基本機能として制限なく実行できます。

設定手順：
1. 管理者による絞り込み設定： 「データベース設定」＞「表示設定」＞「絞り込み設定」
  API専用の絞り込み設定を1つ新規作成します。
2. 条件の追加集約： 条件の設定画面において、「条件追加」ボタンをクリックし、適用したい複数の抽出条件（条件A かつ 条件B または 条件C 等）をAND/OR階層を用いて1つの絞り込みパターンとして組み込み、確定保存します。
3. APIでの呼び出し： 「管理者設定」＞「APIパラメータ情報」
作成したAPI専用絞り込みパターンの「絞り込み設定ID」を確認し、APIのパラメータ  "searchId" へ指定します。
これにより、複雑な複数条件を掛け合わせたレコード抽出が1回のリクエストで安全に完結します。

関連マニュアル

詳細な仕様の違いや作成手順については、サクセスナビの下記記事をご確認ください。

絞り込み条件の構成と演算子の仕様に関するマニュアル

「楽楽販売」で設定可能な絞り込み条件（AND/OR条件）の作り方、および複数条件を1つのパターンに集約・追加する手順を詳しく解説しています。
検索方法：検索条件の構成

（記事ID：2931）

レコード更新APIで送信データに含まれない明細行を自動的に削除することはできません

現在の「楽楽販売」の仕様では、レコード更新APIを用いて明細行（テーブル形式の項目）を更新する際、リクエストデータに含まれていない既存の明細行を自動で判別して削除する機能はありません。

「楽楽販売」のAPIは、指定された更新キー（明細キーなど）に基づいて特定の行を書き換える、あるいは新しい行を追加する仕組みとなっています。
そのため、例えば元々4行あった明細に対して3行分の更新データのみを送信した場合、システム側では「残りの1行を削除する」という判断は行わず、指定されなかった4行目のデータはそのままデータベースに残る挙動となります。

また、レコード削除APIについても「レコード単位（親データごと）」の削除を目的とした機能であり、特定の明細1行のみを指定してピンポイントで削除するリクエストには対応していません。

お問い合わせフォームよりご要望をお寄せください。

「楽楽販売」はお客様から頂戴したご意見・ご要望をもとに、
よりよく、寄り添う 販売管理クラウドを目指してまいります。

現在の仕様ではご希望の機能に対応しておりませんが、
お客様からの貴重なご意見として真摯に受け止め、今後の改善に役立ててまいります。

API連携および明細更新に関する仕様とマニュアル

APIの正式なリクエスト形式や、自動処理における明細更新のロジックについては、下記記事をご確認ください。

API連携オプションの基本仕様と設定マニュアル

外部システムから「楽楽販売」へリクエストを投げる際の接続先URLや、JSON形式のパラメータ指定例について詳しく解説しています。
API連携オプション：設定方法

自動処理における明細更新の4つのパターン

APIではなく「楽楽販売」内部の自動処理で明細を更新する際の挙動（末尾に追加、すべて削除してから追加など）について記載されています。APIでのデータ構成を検討する際の参考になります。
自動処理設定：「レコード更新」パーツ

（記事ID：2923）

APIで実行対象のデータベースを変更する際は、IDの書き換えだけでなく「インポート設定の列構成」の再確認が必要です。

API連携（CSVデータインポートAPIやCSVファイルインポートAPIなど）において、接続先のデータベースを切り替える場合、プログラム上の「データベースID（dbSchemaId）」や「インポート設定ID（importId）」を書き換えるだけでは不十分なケースがあります。

システムの正確性を保つためのセキュリティ制限や、データベースごとのインポートルールの違いにより、処理が失敗したり、API上は正常終了しているのにデータが登録されなかったりする事象が発生します。

主な事象

過去の問い合わせデータやFAQでは、データベースの切り替え時に以下のようなトラブルが報告されています。

• APIを実行すると「403：アクセスが拒否されました」というエラーが返ってくる。
• APIのレスポンスは「complete（成功）」となっているのに、対象のデータベースを確認してもレコードが1件も登録されていない。
• 手動でのインポートは成功するのに、API経由で同じIDを指定するとエラー（400：パラメータが不正です）になる。

これらのトラブルは、主に「接続許可設定」や「パラメータの記述ルール」の見落としが原因です。以下の確認・対処手順に沿って設定を見直してください。

エラーを解消するための確認・対処手順

1. インポート設定の「列の並び順」と「項目数」がCSVファイルと一致しているか確認する

API上は正常終了しているのにデータが登録されない場合、指定した「インポート設定ID（importId）」の内容が、送信しているCSVファイルの構造と合致していない可能性があります。手動インポートと異なり、APIでは「設定とファイルの不一致」が原因で全行がスキップされることがあります。

【確認箇所】 DB設定 ＞ 機能設定 ＞ インポート一覧 ＞ 該当設定の「項目設定」

【確認・対処手順】
1. 切り替え先のデータベースに作成した「インポート設定」を開きます。
2. 「項目設定」画面で、設定されている項目の数と並び順が、APIで送信するCSVファイルの列構成と完全に一致しているか確認してください。
3. 不要な列がある場合は「スキップ項目」を配置し、不足している場合は項目を追加してください。項目数や並び順が1つでもズレていると、入力検証エラーにより登録がスキップされます。

2. JSONパラメータの「大文字・小文字」が正確か再チェックする

APIリクエスト時に送信するJSONパラメータ（dbSchemaId, importId, keyIdなど）は、大文字と小文字を厳密に区別します。プログラムをコピー＆ペーストして作成した際に、一部の文字が異なっていると「パラメータが不正です（400エラー）」となります。

【確認・対処手順】
1. リクエストボディのJSONを確認します。
2. 例えば「KeyId」と記述している場合、正しくは「keyId」です。マニュアルに記載された正確なパラメータ名（例：dbSchemaId, importId）と一字一句違わないか、スペルミスがないかを確認してください。

3. APIトークンを発行したユーザーの「全体権限」と「DBアクセス権」を確認する

API実行に使用している「APIトークン」に紐づく実行ユーザーが、新しく指定したデータベースに対して適切な権限を持っていない場合、インポート設定（importId）を正しくロードできず処理が失敗します。

【確認箇所】 管理者設定 ＞ ユーザー設定 ＞ ユーザー管理 ＞ [対象ユーザーの「設定」および「アクセス権」]

• 【必要な機能権限】：
  ユーザーの基本設定にて、全体権限の「DB設定」権限にチェックが入っているか確認してください。
• 【必要なデータベースアクセス権】：
  対象のユーザー（または所属するユーザーグループ）に対し、接続先のデータベースの「参照」アクセス権および「管理」アクセス権が100%付与されているか確認してください。
  特に「管理」アクセス権がないデータベースに対しては、APIによるインポート設定の呼び出し、および失敗時のエラーログ（エラーデータ.csv）のダウンロードがシステム仕様上制限され、アクセス拒否（403）となります。

関連マニュアル

詳細な仕様の違いや作成手順については、下記記事をご確認ください。

API連携の接続先URLやパラメータの詳細に関するマニュアル

CSVエクスポートやインポートAPIの正式なエンドポイントURL、リクエスト形式の具体例について解説しています。
API連携オプション：設定方法

インポート設定の項目紐付けに関するマニュアル

CSVファイルの列とデータベース項目を正しく対応させるための「項目設定」の手順や、スキップ項目の活用方法について記載しています。
インポート一覧：項目設定

API連携でエラーが発生した際のトラブルシューティング

403エラー（アクセス拒否）や400エラー（パラメータ不正）の具体的な原因とチェックリストをまとめています。
API連携オプション：エラー「アクセスが拒否されました。」と表示された

（記事ID：2924）

「楽楽販売」の画面上でAPIのリクエスト回数を直接確認したり、統計データとして出力したりすることはできません

APIの実行回数（リクエスト数）を日時別や日付別に自動でカウントして表示する専用のダッシュボードや、ご契約プランの利用上限に対する現在の稼働率を直接確認できる画面はありません。

また、APIのリクエスト数のみを抽出して統計レポートとして一括出力する機能も備わっていない仕様です。

これは、システムの処理負荷を抑え、リアルタイムなデータ連携の正確性を保つための仕組みとして、ログの蓄積と統計表示を切り離して管理しているためです。

そのため、ユーザーがAPIの稼働状況や上限との乖離状況を把握するためには、お手数をおかけしますが、システムが記録している「操作ログ」をCSV形式で出力し、お客様ご自身で集計作業を行っていただく必要があります。

APIの実行回数を効率的に集計して稼働状況を把握するための代替案

直接的な確認機能はありませんが、管理者設定の「ログ一覧」にはAPIを介した操作もすべて記録されています。
このデータを活用して、現場でのリクエスト数を算出する具体的な手順をご案内します。

管理者設定の「ログ一覧」でAPI関連の操作に絞り込んで検索し、出力したCSVファイルをExcelのピボットテーブル等で集計して日時別の実行回数を算出する

APIの実行状況を正確に把握するために、以下の手順で操作ログの抽出と集計を行ってください。

1. 必要な権限の確認
操作ログを閲覧・出力するためには、対象のユーザーに「ログ閲覧」および「ログ出力」の権限が付与されている必要があります。権限がない場合は、管理者に設定の変更を依頼してください。

2. 操作ログの検索と絞り込み
【設定箇所】 管理者設定＞メンテナンス機能＞ログ一覧
1. 「操作日時」にて、確認したい期間を指定します。※一度に検索できる期間は最長で3か月分までです。
2. 「操作」の項目にて、以下のAPIに関連する操作を選択して検索を実行します。
・APIによるレコード登録／更新／削除／参照
・APIによるIP認証エラー（接続拒否の状況を確認したい場合）
※特定のデータベースに対するAPI実行数を知りたい場合は、「DB・フォルダ名」に対象のデータベース名を入力してください。

3. CSVデータの出力とExcelでの集計
1. 検索結果が表示されたら、画面右上の「CSV出力」ボタンをクリックし、ログデータをダウンロードします。
2. ダウンロードしたCSVファイルをExcelで開き、挿入タブの「ピボットテーブル」を活用します。
3. 行ラベルに「操作日時（日付や時間単位でグループ化）」、値に「ID」や「操作」を配置することで、1分間あたり、または1日あたりのリクエスト回数を可視化できます。これにより、プランの上限値（例：スタンダードプランなら1分間20リクエスト）に対して、どの程度の余裕があるか、あるいはどの時間帯に負荷が集中しているかを具体的に把握することが可能です。

操作ログの仕様確認とマニュアル

操作ログに記録される内容の詳細や、ログの保存期間の設定については、下記記事をご確認ください。

操作ログの検索手順や記録される操作内容の詳細を確認する

ログ一覧で確認できる「いつ・誰が・どこで・何をしたか」の情報の見方や、CSV出力の方法について詳しく解説しています。
ログ一覧

操作ログの保存期間や詳細情報の保存設定を変更する

ログがどのくらいの期間システムに保持されるかの設定方法です。集計に必要な期間のログが消えないよう、事前に設定状況を確認してください。
全体詳細設定

お問い合わせフォームよりご要望をお寄せください。

「楽楽販売」はお客様から頂戴したご意見・ご要望をもとに、
よりよく、寄り添う 販売管理クラウドを目指してまいります。

現在の仕様ではご希望の機能に対応しておりませんが、
お客様からの貴重なご意見として真摯に受け止め、今後の改善に役立ててまいります。

（記事ID：2932）

レコード登録APIにおいて、従属項目の自動取得設定を有効にしながら一部の項目に任意値を指定して登録することはできません

現在の「楽楽販売」のAPI連携の仕様では、レコード登録APIのリクエストパラメータにおいて、関連マスタから従属項目を自動取得する設定（"getSubordinate": "1"）を有効にしている場合、リクエスト内容（values内）に含まれる従属項目への値指定は受け付けられない仕組みとなっています。

この自動取得が有効な状態で、valuesパラメータ内に従属項目の値を指定して送信すると、システムの整合性を保つための制限バリデーションにより、以下のエラーが発生してレコードの登録処理全体が強制ロールバック（失敗）されます。

• レスポンスHTTPステータス： 400 Bad Request（パラメータ不正）
• エラーコード（code）： 100
• エラーメッセージ（msg）：
  「従属項目を取得する場合は、従属項目に値を指定することができません。」

そのため、特定の従属項目にのみ外部システムから独自の文言を上書きして登録したい場合は、お手数をおかけしますが、以下の代替案による連携プログラムの設計・構築をご検討ください。

従属項目の一部に任意値を登録するための「2つの解決代替案」

自動取得機能の稼働と任意値の直接指定を1回のリクエストで共存させることはできませんが、APIのパラメータ指定方法や実行手順を工夫することで、安全に目的のデータ登録を実現することが可能です。

代替案1： getSubordinate を 0 に設定し、送信元の外部システム側で全従属項目の値を組み立てて送信する

「楽楽販売」側での自動取得に頼らず、連携元の外部システム（kintone、基幹システム、連携ツールなど）側で、マスタから引用する値と独自に上書きしたい値をあらかじめすべてマージ・構築してから送信する方法です。

【設定・実行手順】：
1. レコード登録APIのリクエストパラメータにて、"getSubordinate": "0" を明示的に指定します（またはパラメータ自体を記述しない）。
2. 外部システム側のプログラムにて、対象レコードの「DBリンク項目」に紐づくすべての従属項目の値を事前に準備します。
3. 上書きしたい従属項目には独自の文言を、それ以外の従属項目にはマスタから取得した値をセットし、一つのJSON valuesパラメータとして「楽楽販売」へ送信します。
※この方法は、すべての従属項目の値を外部から明示的に引き渡す必要があるため、外部システム側でマスター情報を一時的、または永続的に保持・参照できる開発環境に適しています。

代替案2： APIを2回に分けて実行し、1回目の登録で自動取得させた後、2回目の更新で特定項目のみを上書きする

「楽楽販売」のマスタ自動取得機能を活かしつつ、登録後に特定の項目だけを任意の外部データで修正する方法です。

【設定・実行手順】：
◆1回目：レコード登録APIの実行（新規追加）
・パラメータを  "getSubordinate": "1" に設定し、マスタに紐づくDBリンク項目（キー値）を指定してリクエストを投げます。
・これにより、すべての従属項目が「楽楽販売」内のマスタデータに基づいて自動的に入力された状態でレコードが新規作成されます。
◆2回目：レコード更新APIの実行（値の書き換え）
・1回目の登録成功レスポンスから作成されたレコードのIDを取得し、そのIDを更新キー（"id" または "keyId"）に指定します。
・パラメータは "getSubordinate": "0" を指定し、上書きしたい特定の従属項目に対してのみ、外部システムから任意の値を  values に格納してリクエストを送信します。従属項目は一度データベースに登録されれば、通常のテキスト項目や数値項目と同様に自由に上書き更新が可能です。

※この方法は、APIを複数回連続して実行（シーケンシャル処理）できるプログラム構成である場合に有効な回避策となります。

注意事項

getSubordinateが「1」でも、2階層目以上の「従属項目の従属項目」は空欄のまま登録されます

業務データベース ➔ マスタデータベース ➔ 親マスタデータベース のように、従属項目を数珠繋ぎ（ネスト）にして2段階以上遡ってデータをコピーする設定をデータベース（データベース）側に施している場合、レコード登録APIにおける自動従属取得は「直近の1階層目（子の従属項目）」しか自動実行されません。
2階層目以降（孫の従属項目）はAPI実行時には完全に無視され、空欄（値なし）のままレコードが登録されます。 ネスト構造の従属項目がある場合は、アプローチAで外部からすべて値を指定して送信するか、手動で一括再取得を行う設計にしてください。

データベース設定に「初期値」があってもAPI登録時は空欄になり、必須項目エラーが発生します

楽楽販売のデータベース項目設定で、対象項目に「初期値（デフォルト値）」を定義していても、APIでのレコード登録時にはその設定は適用されず、送信データに含めない限り空欄（null）として処理されます。
そのため、必須項目だからと「初期値が設定してあるから大丈夫だろう」とAPIの values パラメータから除外して送信すると、「'○○'を入力してください。（エラーコード100）」というパラメータ不正エラーが発生し、登録全体が失敗します。
API実行時は、必須項目にはすべて明示的に値を直接指定してリクエストを送信してください。

お問い合わせフォームよりご要望をお寄せください。

「楽楽販売」はお客様から頂戴したご意見・ご要望をもとに、
よりよく、寄り添う 販売管理クラウドを目指してまいります。

現在の仕様ではご希望の機能に対応しておりませんが、
お客様からの貴重なご意見として真摯に受け止め、今後の改善に役立ててまいります。

関連マニュアル

APIを利用したデータの登録・更新に関する詳細仕様、およびエラー発生時の詳細な解決手順については、サクセスナビの下記記事をご確認ください。

API連携オプション：設定方法に関するマニュアル

外部システムから「楽楽販売」へAPI（POSTメソッド）を投げる際のURL形式、認証ヘッダ（X-HD-apitoken）の記述方法、JSONパラメータの構成規則、および送信可能なデータ型の詳細を解説しています。
API連携オプション：設定方法

（記事ID：2940）