レポートをスケジューリングする
Report Schedule APIは、レポートスケジュールの取得、作成、削除を行うためのAPIです。
レポートスケジュールを作成することで、レポートが自動的に生成されるようになります。
Note: レポートスケジュールはセラーセントラルのレポート機能を使用して作成することも可能です。
Get Report Schedules APIでは、現在設定されているすべてのレポートスケジュールの詳細を取得することが可能です。
Get Report Schedule By Id APIでは、個別のレポートスケジュールの詳細を取得することが可能です。
Create Report Schedule および Cancel Report Schedule APIでは、レポートスケジュールを作成したり、既存のスケジュールを削除することができます。
Get Report Schedules
指定された条件にマッチしたレポートスケジュールの詳細を返します。
リクエスト
リクエストパラメータ
| Name | Location | Description |
|---|---|---|
| reportTypes (任意) Type: string (comma-seperated list of ReportType) |
Query Parameter | レポートの種類リスト |
レスポンス
処理が成功した場合、HTTP 200ステータスコードを返します。
{
"reportSchedules": [
{
"reportScheduleId" : "68973459224",
"reportType" : "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
"scheduleFrequency" : "P1D",
"nextReportCreationTime": "20221118T150630Z"
}
]
}
Get Report Schedule By Id
指定された reportScheduleIdのレポートスケジュール詳細を返します。
リクエスト
リクエストパラメータ
| Name | Location | Description |
|---|---|---|
| reportScheduleId (required) Type: string |
Path Parameter | レポートスケジュールのID |
レスポンス
処理が成功した場合、HTTP 200 ステータスコードを返します。
{
"reportSchedules": [
{
"reportScheduleId" : "68973459224",
"reportType" : "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
"scheduleFrequency" : "P1D",
"nextReportCreationTime": "20221118T150630Z"
}
]
}
Create Report Schedule
指定された reportTypeのレポートスケジュールを作成します。設定できるスケジュールは reportType ごとに一つのみです。
リクエスト
リクエストパラメータ
| 名前 | ロケーション | 説明 |
|---|---|---|
| deleteExistingSchedule (任意) Type: boolean |
Query Parameter | trueを指定した場合は、指定した reportType の既存のレポートスケジュールを削除します。falseを指定して実行した際に当該 reportType のスケジュールがすでに存在している場合は、APIで配列を返します。
デフォルト: false |
| reportType (必須) Type: ReportType |
Body | スケジュールを作成したいレポートの種類 |
| scheduleFrequency (必須) Type: ScheduleFrequency |
Body | レポートを作成する頻度 |
| nextReportCreationTime (必須) Type: string (date-time ISO 8601) |
Body | ISO 8601形式での次回レポート作成日時 |
リクエストボディ
{
"reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
"scheduleFrequency": "P1D",
"nextReportCreationTime": "20220806T235959Z"
}
レスポンス
処理が成功した場合、HTTP 201ステータスコードを返します。
{
"reportScheduleId": "68973459224",
}
Cancel Report Schedule
指定された reportScheduleIdのスケジュールを削除します。
リクエスト
リクエストパラメータ
| 名前 | ロケーション | 説明 |
|---|---|---|
| reportScheduleId (必須) Type: string |
Path Parameter | レポートスケジュールのID |
レスポンス
処理が成功した場合、HTTP 200 ステータスコードを返します。