getSales
Retrieve order records with customizable filters: by date range, customer ID/name/email, payment, delivery, cancellation, and email status. Supports pagination and field selection for targeted data extraction.
Instructions
受注データを一覧取得します。パラメータ未指定で直近 1 週間分、期間指定は受注日または更新日のいずれかで可能。購入者(顧客 ID・氏名・メール)による絞り込み、入金/配送/キャンセル状態での絞り込み、各種メール送信状態による絞り込みが可能(具体的なパラメータと指定方法はスキーマを参照)。limit(最大 100、デフォルト 10)/ offset でページング、fields でレスポンスキー絞り込み。特定受注は getSale、売上集計は statSale、更新系は updateSale / cancelSale / sendSalesMail。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | 受注IDで検索。カンマ区切りで複数指定可能 | |
| after | No | 指定日時以降の受注から検索。 `after` 未指定時は `before` の指定日時の7日前の0時、 `before` 未指定時は現在から7日前の0時がデフォルト値となります。 | |
| before | No | 指定日時以前の受注から検索 | |
| make_date_min | No | `after`と同義 | |
| make_date_max | No | `before`と同義 | |
| update_date_min | No | 指定日時以降に更新された受注から検索 | |
| update_date_max | No | 指定日時以前に更新された受注から検索 | |
| customer_ids | No | 購入した顧客IDで検索。カンマ区切りにすることで複数検索が可能 | |
| customer_name | No | 購入した顧客名で部分一致検索 | |
| customer_furigana | No | 購入した顧客フリガナがで部分一致検索 | |
| customer_mail | No | 購入した顧客メールアドレスで部分一致検索 | |
| accepted_mail_state | No | 受注メールの送信状態で検索 - `not_yet`: 未送信 - `sent`: 送信済み - `pass`: 送信しない | |
| paid_mail_state | No | 入金メールの送信状態で検索 - `not_yet`: 未送信 - `sent`: 送信済み - `pass`: 送信しない | |
| delivered_mail_state | No | 配送メールの送信状態で検索 - `not_yet`: 未送信 - `sent`: 送信済み - `pass`: 送信しない | |
| mobile | No | `true`なら携帯からの受注のみ取得 | |
| paid | No | `true`なら入金済みの受注のみ取得 | |
| delivered | No | `true`なら配送済みの受注のみ取得 | |
| canceled | No | `true`ならキャンセル済みの受注のみ取得 | |
| payment_ids | No | 使用された決済のIDで検索。カンマ区切りで複数指定可能 | |
| fields | No | レスポンスJSONのキーをカンマ区切りで指定 | |
| limit | No | レスポンスの件数を指定。指定がない場合は10。最大100 | |
| offset | No | 指定した数値+1件目以降のデータを返す |