Merci de votre visite. Cette page est disponible en anglais uniquement.

Managing report schedules

The Report Schedule APIs allow you to query, create or delete report schedules. Report Schedules allow you to request reports to be automatically created for you.
Use the Get Report Schedules API to list all your current report schedules, the Get Report Schedule By Id API to get details of an individual Report Schedule. The Create Report Schedule and Cancel Report Schedule APIs allow you to create or cancel report schedules.


Get Report Schedules

Returns report schedule details that match the filters criteria specified.

Request

Request parameters

Name Location Description
reportTypes
(optional)

Type: string (comma-separated list of ReportType)
Query Parameter List of report types

Sample Code

Response

Returns HTTP 200 status response code if the operation was successful.

{
      "reportSchedules": [
            {
                  "reportScheduleId" : "68973459224",
                  "reportType" : "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
                  "scheduleFrequency" : "P1D",
                  "nextReportCreationTime": "20221118T150630Z"
            }
      ]
}

Get Report Schedule By Id

Returns report schedule details for the given reportScheduleId.

Request

Request parameters

Name Location Description
reportScheduleId
(required)

Type: string
Path Parameter Id of the report schedule

Sample Code

Response

Returns HTTP 200 status response code if the operation was successful.

{
      "reportSchedules": [
            {
                  "reportScheduleId" : "68973459224",
                  "reportType" : "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
                  "scheduleFrequency" : "P1D",
                  "nextReportCreationTime": "20221118T150630Z"
            }
      ]
}

Create Report Schedule

Creates a report schedule for the given reportType. Only one schedule per report type allowed.

Request

Request parameters

Name Location Description
deleteExistingSchedule
(optional)

Type: boolean
Query Parameter If true deletes an existing report schedule for the given report type. The API returns an array, if a schedule for the given report type already exists and set to false.

Default: false
reportType
(required)

Type: ReportType
Body Type of the report for the schedule
scheduleFrequency
(required)

Type: ScheduleFrequency
Body Frequency in which the report shall be created.
nextReportCreationTime
(required)

Type: string (date-time ISO 8601)
Body ISO 8601 time defining the next report creation time

Request body

{
    "reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
    "scheduleFrequency": "P1D",
    "nextReportCreationTime": "2022-08-06T23-59-59Z"
}

Sample Code

Response

Returns HTTP 201 status response code if the operation was successful.

{
     "reportScheduleId": "68973459224",
}

Cancel Report Schedule

Cancels the report schedule with the given reportScheduleId.

Request

Request parameters

Name Location Description
reportScheduleId
(required)

Type: string
Path Parameter Report schedule identifier

Sample Code

Response

Returns HTTP 200 status response code if the operation was successful.