Search (検索) API

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

Attribute

Name Type Description
object string

固定値 search

location string

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

data Array

検索結果。

filters Object

検索パラメータ。

order string

検索結果のオーダーが返されます。

page integer

現在の結果のページ番号。

per_page integer

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

query string

検索クエリ。。

scope string

検索された"scope"(スコープ)、または検索されるデータのタイプ。

total integer

検索結果のデータ(レコード)の合計量。

total_pages integer

検索結果の総ページ数。

検索を行う

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

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

Request Parameter

Name Type Description
scope string

必須)あなたが検索している範囲は、charge(課金)、dispute(チャージバック)、recipient(受取人)、customer(顧客)、refund(返金)、transfer(送金)、links(リンク)のいずれかです。Search Query and Filtersの利用可能なオプションを参照してください。

order string

(*オプション、デフォルト:reverse_chronological) The order of the list returned: chronological (古い順), reverse_chronological (新しい順).

query string

(オプション、デフォルト: '空白の固定値') スコープ内のテキストを検索します。 Search Query and Filtersを参照して下さい。

filters Object

(オプション, デフォルト: {空白のオブジェクト}) スコープ内の特定のキーのテキストを検索します。Search Query and Filtersを参照して下さい。

page integer

(オプション, デフォルト: 1) 検索結果のページ数。

per_page integer

(オプション, デフォルト: 30, 最高値: 100) 検索結果の1ページあたりのアイテム数。

Example

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