顧客を検索

GEThttps://api.omise.co/customers/search

メール、説明、メタデータなどで顧客レコードを検索およびフィルタリングします。Search APIは、すべての顧客に対して強力な全文検索機能を提供します。

---

リクエストパラメータ

推奨 - 2 フィールド推奨パラメータ

▼

`query`STRING(optional)

検索クエリ文字列。顧客のメール、説明、メタデータを横断して検索します。複数の単語（AND論理）と部分一致をサポートします。

Example:"john@example.com"

`filters`OBJECT(optional)

検索結果を絞り込むフィルタ条件。一般的なフィルタにはメール、説明、作成日範囲、メタデータフィールドが含まれます。

Example:{"email":"john@example.com"}

追加 - 3 フィールド追加パラメータ

▼

---

レスポンス

200

検索成功

検索が正常に完了しました。data配列に一致する顧客を含む検索結果オブジェクトを返します。

レスポンスに含まれる情報:

• 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

見つかりません

検索エンドポイントが見つからないか、無効なスコープです。

一般的な原因:

• 無効な検索スコープ
• 不正なエンドポイントURL

5xx

サーバーエラー

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

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/customers/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "scope=customer" \
  -d "query=john@example.com" \
  -d "filters[email]=john@example.com"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Search.execute({
  scope: 'customer',
  query: 'john@example.com',
  filters: {
    email: 'john@example.com'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Search.execute(
    scope='customer',
    query='john@example.com',
    filters={
        'email': 'john@example.com'
    }
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const results = await omise.search.execute({
  scope: 'customer',
  query: 'john@example.com',
  filters: {
    email: 'john@example.com'
  }
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$results = OmiseSearch::execute([
    'scope' => 'customer',
    'query' => 'john@example.com',
    'filters' => [
        'email' => 'john@example.com'
    ]
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Map<String, Object> filters = new HashMap<>();
filters.put("email", "john@example.com");

SearchResult<Customer> results = client.search()
    .scope("customer")
    .query("john@example.com")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Search.Execute(new SearchRequest
{
    Scope = "customer",
    Query = "john@example.com",
    Filters = new Dictionary<string, object>
    {
        { "email", "john@example.com" }
    }
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

results, _ := client.Search(&operations.SearchCustomers{
    Scope: "customer",
    Query: "john@example.com",
    Filters: map[string]interface{}{
        "email": "john@example.com",
    },
})

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
bad_request	パラメータの欠落または無効	パラメータが有効か確認
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
invalid_scope	無効な検索スコープ	スコープが"customer"に設定されているか確認

検索フィルタオプション

フィルタ	型	説明
email	string	顧客のメールアドレス
description	string	顧客の説明または名前
created	object	日付範囲フィルタ（例: {gte: '2025-01-01', lte: '2025-01-31'}）
metadata	object	カスタムメタデータのキーと値のペア

---

🔑API認証情報

▼

試してみる

推奨 - 2項目

▼

追加 - 3項目

▼

あなたのIP: ...読み込み中...