Search （検索） API

Search APIでは、様々なデータのスコープ（範囲）を検索し、結果を取得できます。サポートされているスコープ（範囲）については、Search Query and Filtersを参照してください。検索結果はデフォルトで、新しい順で配信されます。

Attributes

Name	Type	Description
object	string	固定値 `search`。
location	string	現在の`search`オブジェクトを取得するためのAPIパス。
aggregate_level	integer	マーチャント階層からサブマーチャントをフェッチするためのアグリゲートレベルです。たとえば、1にした場合、マスターマーチャントの１レベル下にあるサブマーチャントをフェッチします。2にした場合、マスターマーチャントの１レベルと２レベル下にあるサブマーチャントをフェッチします。
data	array	ページ付けされた検索結果。
export	object_id_expandable	The export identifier matching `/xprt(_test)?_[0-9a-z]+/`.
filters	object	検索フィルタsearch query and filtersを参照）。
order	string	検索結果の順番。
page	integer	現在の結果のページ番号。
per_page	integer	リクエストに送信された1ページあたりのアイテム。
query	string	検索クエリ(search query and filtersを参照）。
scope	string	検索された範囲（データの種類）。
total	integer	返されたレコード数。
total_pages	integer	返されたレコードのページ数。

Example

JSON Response

{
  "object": "search",
  "export": null,
  "data": [
    {
      "object": "transfer",
      "id": "trsf_test_no1t4tnemucod0e51mo",
      "livemode": false,
      "location": "/transfers/trsf_test_no1t4tnemucod0e51mo",
      "fail_fast": false,
      "paid": false,
      "sent": false,
      "sendable": true,
      "currency": "thb",
      "amount": 47448,
      "fee": 3000,
      "metadata": {},
      "recipient": "recp_test_no1t4tnemucod0e51mo",
      "transaction": null,
      "schedule": null,
      "bank_account": {
        "object": "bank_account",
        "account_type": null,
        "bank_code": null,
        "branch_code": null,
        "brand": "test",
        "created": "2019-12-31T12:59:59Z",
        "last_digits": "6789",
        "name": "DEFAULT BANK ACCOUNT"
      },
      "failure_code": null,
      "failure_message": null,
      "created": "2019-12-31T12:59:59Z",
      "paid_at": null,
      "sent_at": null
    }
  ],
  "page": 1,
  "per_page": 1,
  "total": 2,
  "total_pages": 2,
  "filters": {},
  "location": "/search",
  "order": "reverse_chronological",
  "query": "",
  "scope": "transfer"
}

検索を行う

- GET https://api.omise.co/search

入力パラメータに基づいて検索結果を返します。注：検索結果のページネーションの仕組みはlistsのものとは異なります。offsetとlimitの代わりに pageとper_pageをご使用ください。

Request Parameters

Name	Type	Description
scope	string	(必須, one of: `charge`, `charge_schedule`, `customer`, `dispute`, `event`, `fund_account`, `link`, `log_entry`, `receipt`, `recipient`, `refund`, `sub_merchant`, `transfer`, `transfer_schedule`, `transaction`) 検索された範囲（データの種類）。
filters	object	(任意) 検索フィルタsearch query and filtersを参照）。
order	string	(任意, default: `chronological`, one of: `chronological`, `reverse_chronological`) 検索結果の順番。
page	integer	(任意, default: `1`) 現在の結果のページ番号。
per_page	integer	(任意, default: `30`) リクエストに送信された1ページあたりのアイテム。
query	string	(任意) 検索クエリ(search query and filtersを参照）。

Example

クエリとフィルタを使用した検索の取得

curl
php
ruby
C#
python
go
elixir

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

<?php

require './omise-php/lib/Omise.php';

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$search = OmiseCharge::search('query string (can be empty)')->filter(array(
    'captured' => true,
    'created'  => "today",
));

print_r($search['data']);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

# You can use the search scope on classes which provides it. The SearchScope
# provides a chainable interface which is very similar to what ActiveRecord
# provides in rails.
search = Omise::Charge.search.filter(paid: true, created: "today").execute

# Or you can use the Search class directly.
search = Omise::Search.execute({
  scope: "charge",
  filters: {
    captured: true,
    created: "today",
  },
})

var charges = await Client.Charges.Search(
    query: "TSUNAMI",
    order: Ordering.ReverseChronological
);

Console.WriteLine($"total tsunami charges: {charges.Total}");

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

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

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.ChargeSearchResult{}

err := client.Do(result, &operations.Search{
	Scope: omise.ChargeScope,
	Query: "John",
	Filters: map[string]string{
		"created":  "2016-08-01..2024-08-30",
		"captured": "true",
	},
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Charge.search(
  filters: [
    paid:    true,
    created: "today"
  ]
)

# Or you can use the Search module directly.
Omise.Search.execute("charge",
  filters: [
    paid:    true,
    created: "today"
  ]
)