CSVエクスポートAPIでメニューの複雑な絞り込み条件(複数設定)を適用してデータを取得することは可能か
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でインポート対象のデータベース(DB)を切り替える際の設定・確認手順
- レコード登録APIの実行時に従属項目の自動取得と任意値の指定を併用する方法・代替案
- APIで明細行を更新する際に行数が減っても余分な行が削除されない事象の解決策
- 外部システムからCSVエクスポートAPIを利用してデータ連携を行う方法・設定手順
- API連携オプション:エラー「内部エラーが発生しました。」と表示された
- API連携オプション:その他のエラー
- API連携オプション:エラー「アクセスが拒否されました。」と表示された
- API連携オプション:エラー「認証エラーです。」と表示された
- API連携オプション:エラー「パラメータが不正です。」と表示された