Search (検索)

Attribute

Name Type Description
object string

固定値 search.

location string

検索結果のデータを取得するためのパス

scope string

検索対象の範囲(※下記の Request Parameterを参照。)

query string

送信されたリクエストに含まれる検索用語句

filters Json

送信されたリクエストに含ま れる検索用語句のうち、特定 のキーに紐づいたもの

page integer

任意:デフォルトは1 リクエスト送信された特定のページ番号。

total_pages integer

検索結果の合計ページ数。

data Array

検索結果。

検索データの取得 

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

検索結果のリストを返します。

Request Parameter

Name Type Description
order string

検索結果の表示順(任意)chronologicalは古い順(デフォルト)、reverse_chronologicalは新しい順でソート

scope string

検索する範囲 例:課金チャージバックレシピエント顧客返金振込リンク先

query string

範囲内に含まれる検索用語句。詳細については検索フィールドを参照。

filters string

範囲内に含まれる検索用語句のうち特定のキーに紐づいたもの。詳細については、フィルタキー・リストを参照。

page integer

任意:デフォルトは1 特定の検索ページ数。

Example

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