Interface ReportSchedule

Detailed information about a report schedule.

Export

ReportSchedule

interface ReportSchedule {
    marketplaceIds?: string[];
    nextReportCreationTime?: string;
    period: string;
    reportOptions?: {
        [key: string]: string;
    };
    reportScheduleId: string;
    reportType: string;
}

Properties

marketplaceIds? nextReportCreationTime? period reportOptions? reportScheduleId reportType

Properties

Optional marketplaceIds

marketplaceIds?: string[]

A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.

Memberof

ReportSchedule

Optional nextReportCreationTime

nextReportCreationTime?: string

The date and time when the schedule will create its next report, in ISO 8601 date time format.

Memberof

ReportSchedule

period

period: string

An ISO 8601 period value that indicates how often a report should be created.

Memberof

ReportSchedule

Optional reportOptions

reportOptions?: {
    [key: string]: string;
}

Additional information passed to reports. This varies by report type.

Type declaration

  • [key: string]: string

Memberof

ReportSchedule

reportScheduleId

reportScheduleId: string

The identifier for the report schedule. This identifier is unique only in combination with a seller ID.

Memberof

ReportSchedule

reportType

reportType: string

The report type. Refer to Report Type Values for more information.

Memberof

ReportSchedule

Settings

Member Visibility

Theme

On This Page

marketplaceIdsnextReportCreationTimeperiodreportOptionsreportScheduleIdreportType