メインコンテンツへスキップ
バージョン: 最新版

サブマーチャントの検索

名前、メールアドレス、事業者詳細、メタデータなどでサブマーチャントを検索・フィルタリングします。Search APIは、プラットフォーム内のすべてのサブマーチャントに対して強力なフルテキスト検索機能を提供します。


リクエストパラメータ

推奨 - 2フィールド推奨パラメータ
`query`STRING(optional)
検索クエリ文字列。サブマーチャント名、メールアドレス、事業者名、説明、メタデータを検索します。複数単語(AND論理)および部分一致をサポート。
Example:"acme electronics"
`filters`OBJECT(optional)
検索結果を絞り込むフィルター条件。一般的なフィルターには、status、type、business_category、作成日範囲があります。
Example:{"status":"active","type":"business"}
ページネーション - 3フィールドページネーションパラメータ

レスポンス

200

検索成功

検索が正常に完了しました。data配列に一致するサブマーチャントを含む検索結果オブジェクトを返します。

レスポンスに含まれる項目:
  • object - 常に "search"
  • data - 検索条件に一致するサブマーチャントオブジェクトの配列
  • total - 検索に一致する結果の総数
  • total_pages - 利用可能なページ数
  • page - 現在のページ番号
  • per_page - 1ページあたりの結果数
  • order - 適用された並べ替え順序(chronologicalまたはreverse_chronological)

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

主な原因:
  • 無効なページ番号(1未満)
  • 無効なper_page値(100を超えるか1未満)
  • 不正な形式のfiltersオブジェクト
  • 無効なフィルターフィールド名

401

認証エラー

認証に失敗しました。APIキーが無効または欠落しています。

主な原因:
  • Authorizationヘッダーの欠落
  • 無効なシークレットキー
  • シークレットキーの代わりにパブリックキーを使用
  • HTTP Basic Auth形式の誤り

404

見つかりません

プラットフォームアカウントが見つからないか、サブマーチャント機能が有効になっていません。

主な原因:
  • アカウントがプラットフォームアカウントではない
  • サブマーチャント機能が有効になっていない
  • プラットフォーム機能を有効にするにはサポートに連絡

5xx

サーバーエラー

サーバー側でエラーが発生しました。まれですが、適切に処理する必要があります。

対処方法:

コードサンプル

curl https://api.omise.co/sub_merchants/search \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-d "query=acme electronics" \
-d "filters[status]=active" \
-d "filters[type]=business"

検索例

名前またはメールアドレスで検索

curl https://api.omise.co/sub_merchants/search \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-d "query=john@example.com"

ステータスフィルターで検索

curl https://api.omise.co/sub_merchants/search \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-d "filters[status]=pending"

事業カテゴリで検索

curl https://api.omise.co/sub_merchants/search \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-d "filters[business_category]=electronics_retail"

日付範囲で検索

curl https://api.omise.co/sub_merchants/search \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-d "filters[created][gte]=2025-01-01" \
-d "filters[created][lte]=2025-03-31"

複数のフィルターを組み合わせた検索

curl https://api.omise.co/sub_merchants/search \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-d "query=premium" \
-d "filters[status]=active" \
-d "filters[type]=business" \
-d "filters[business_category]=electronics_retail" \
-d "per_page=50"

エラーコードと結果コード

一般的なエラーコード

コード説明解決方法
bad_requestパラメータの欠落または無効パラメータが有効か確認
authentication_failure無効なAPIキーシークレットキーが正しいか確認
platform_not_enabledプラットフォーム機能が有効になっていないプラットフォームアカウントを有効にするにはサポートに連絡

検索フィルターオプション

フィルタータイプ説明
statusstringサブマーチャントのステータス(pending、active、suspended、deactivated、rejected)
typestringサブマーチャントのタイプ(individual、business)
business_categorystring事業カテゴリコード
createdobject日付範囲フィルター(例: {gte: '2025-01-01', lte: '2025-01-31'}

検索可能なフィールド

検索クエリは以下のフィールドに対してマッチングします:

  • name - サブマーチャントの表示名
  • email - 連絡先メールアドレス
  • business_name - 登記された事業者名
  • description - 内部説明
  • metadata - カスタムメタデータ値

🔑API認証情報

試してみる

推奨 - 2項目
追加 - 3項目
あなたのIP: ...読み込み中...