Universal search

GEThttps://api.omise.co/search

入力パラメータに基づいてデータのスコープを検索します。このエンドポイントを使用して、charge、customer、dispute、recipient、およびその他のリソース全体で全文検索とフィルタリングされたクエリを実行します。

---

🔑API認証情報

▼

---

リクエストパラメータ

必須 - 1項目必須パラメータ

▼

`scope`STRING(required)

検索するデータタイプ。検索されるリソースタイプと利用可能なフィルターを決定します。

Example:"charge"

Values:audit, charge, charge_schedule, customer, dispute, event, link, linked_account, log_entry, receipt, recipient, refund, sub_merchant, transfer, transfer_schedule, transaction

推奨 - 4項目推奨パラメータ

▼

`query`STRING(optional)

全文検索用の検索クエリテキスト。スコープに応じて、ID、説明、メタデータ、メール、名前全体を検索します。

Example:"john@example.com"

`filters`OBJECT(optional)

結果を絞り込むための検索フィルター。利用可能なフィルターはスコープによって異なります。一般的なフィルターには、ステータス、金額、作成日範囲が含まれます。

Example:{"created":"2019/01/01..2019/12/31"}

`order`STRING(optional)

作成時刻に基づく結果の並び順。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

`page`INTEGER(optional)

ページネーションのページ番号（1から始まる）。

Example:1

Default:1

追加 - 1項目追加パラメータ

▼

---

レスポンスs

200

検索成功

data配列にページネーションされた結果を含むsearchオブジェクトを返します。

レスポンス構造:

• object - 文字列値「search」
• data - スコープに一致するオブジェクトの配列（デフォルトで逆時系列）
• page - 現在のページ番号
• per_page - ページごとのレコード数
• total - クエリに一致するレコードの総数
• total_pages - ページの総数
• filters - 適用された検索フィルター
• query - 使用された検索クエリ
• scope - 検索されたリソースタイプ
• location - APIエンドポイントのパス
• order - 適用された結果の並び順

ページネーションに関する注意:

• pageとper_pageを使用します（標準のリストエンドポイントとは異なります）
• デフォルトで逆時系列順に結果が配信されます
• ページあたり最大100件の結果をサポートします

400

不正なリクエスト

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

一般的な原因:

• 必須のscopeパラメータが欠落している
• 無効なscope値
• 不正な形式のfiltersオブジェクト
• filtersの無効な日付形式

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが欠落している
• 無効なシークレットキー
• シークレットキーの代わりに公開キーを使用している
• HTTP Basic Auth形式が正しくない

---

コードサンプル

cURL

curl https://api.omise.co/search \
  -X GET \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "scope=charge" \
  -d "query=thb" \
  -d "filters[created]=2019/01/01..2019/12/31"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = Omise::Search.execute(
  'charge',
  query: 'thb',
  filters: { created: '2019/01/01..2019/12/31' }
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = omise.Search.execute(
    'charge',
    query='thb',
    filters={'amount': '1000..2000', 'captured': 'true'}
)

Node.js

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

const search = await omise.search.list({
  scope: 'charge',
  query: 'thb',
  filters: {
    created: '2019/01/01..2019/12/31'
  }
});

PHP

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

$search = OmiseSearch::execute([
    'scope' => 'charge',
    'query' => 'thb',
    'filters' => [
        'created' => '2019/01/01..2019/12/31'
    ]
]);

Java

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

SearchResult<Charge> search = client.search()
    .scope(SearchScope.Charge)
    .query("thb")
    .filter("created", "2019/01/01..2019/12/31")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var search = await client.Search.Execute(new SearchRequest
{
    Scope = "charge",
    Query = "thb",
    Filters = new Dictionary<string, object>
    {
        { "created", "2019/01/01..2019/12/31" }
    }
});

Go

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

search, _ := client.Search(&operations.SearchOptions{
    Scope: "charge",
    Query: "thb",
    Filters: map[string]interface{}{
        "created": "2019/01/01..2019/12/31",
    },
})

---

エラーおよび結果コード

一般的なフィルターパターン

フィルター構文	説明	例
field=value	完全一致	status=successful
field=val1..val2	範囲	amount=1000..5000
field=date..date	日付範囲	created=2019/01/01..2019/12/31
field=true/false	ブール値	captured=true

スコープ別の利用可能なフィルター

Chargeスコープ:

• status - successful、failed、pending、expired
• amount - 正確な金額または範囲（1000..5000）
• captured - true/false
• created - 日付範囲（2019/01/01..2019/12/31）

Customerスコープ:

• created - 日付範囲

Disputeスコープ:

• status - open、pending、won、lost
• created - 日付範囲

Recipientスコープ:

• active - true/false
• verified - true/false

---

試してみる

必須 - 1項目

▼

scope(必須)

推奨 - 4項目

▼

追加 - 1項目

▼