Search (検索) API

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

Attributes

Name Type Description
object string

固定値 search

location string

現在のsearchオブジェクトを取得するためのAPIパス。

data array

ページ付けされた検索結果。

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

返されたレコードのページ数。

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

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

Request Parameters

Name Type Description
scope string

(必須) 検索された範囲(データの種類)。

filters object

(任意) 検索フィルタsearch query and filtersを参照)。

order string

(任意, default: reverse_chronological) 検索結果の順番。

page integer

(任意) 現在の結果のページ番号。

per_page integer

(任意) リクエストに送信された1ページあたりのアイテム。

query string

(任意) 検索クエリ(search query and filtersを参照)。

Example

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