Skip to main content
売上一覧取得
GET

Authorizations

Authorization
string
header
required

APIキーをBearerトークンとして指定

Query Parameters

date_from
string

期間の開始日(YYYY-MM-DD)。売上日時がこの日以降の売上

date_to
string

期間の終了日(YYYY-MM-DD)。売上日時がこの日までの売上

payment_type
enum<string>

支払方法で絞り込み。credit_card: クレジットカード払い / bank_transfer: 銀行振込(イベントの入金行は含まれなくなります)

Available options:
credit_card,
bank_transfer
product_id
string

商品IDで絞り込み(イベントの入金行は含まれなくなります)。event_id とは同時に指定できません

event_id
string

イベントIDで絞り込み(そのイベントの入金行だけになり、商品の売上は含まれません)。product_id とは同時に指定できません

product_detail_id
string

商品詳細IDで絞り込み(イベントの入金行は含まれなくなります)

amount_from
integer

金額の下限(この金額以上の売上)

amount_to
integer

金額の上限(この金額以下の売上)

name
string

購入者の名前で部分一致検索

mail
string

購入者のメールアドレスで部分一致検索

phone
string

購入者の電話番号で部分一致検索(ハイフンを含めて指定するとハイフンと空白を除いて比較します)

tracking_name
string

登録経路名で部分一致検索(登録経路名と最初のステップの登録経路名のどちらかに一致)

status
enum<string>

ステータスで絞り込み。paid: 決済成功 / pending: 振込待ち / failed: 決済失敗(paid 以外を指定するとイベントの入金行は含まれなくなります)

Available options:
paid,
pending,
failed
is_test_mode
boolean

決済モードで絞り込み(true はテストモード、false は本番モード。未指定は両方)

page
integer

ページ番号

Required range: x >= 1
per_page
integer
default:20

1ページあたりの件数(既定20・最大100。超過時は100に丸められます)

Required range: 1 <= x <= 100

Response

売上一覧

data
object[]
meta
object