Skip to main content

reports get
command

Download a report for a specific date.

Anchor to argumentsArguments

Anchor to date date string required: The date for the report in UTC (YYYY-MM-DD format)
Anchor to report-type report-type string required: The report type (see reports list)

clireportsGetArgs

date
The date for the report in UTC (YYYY-MM-DD format)
```
string
```
report-type
The report type (see `reports list`)
```
string
```

export interface clireportsGetArgs {
  /**
   * The report type (see `reports list`)
   */
  'report-type': string

  /**
   * The date for the report in UTC (YYYY-MM-DD format)
   */
  date: string
}

Was this section helpful?

Anchor to optionsOptions

Anchor to --output --output string: Output file path (defaults to report__.csv)

clireportsGetOptions

--output
Output file path (defaults to report_<type>_<date>.csv)
```
string
```

export interface clireportsGetOptions {
  /**
   * Output file path (defaults to report_<type>_<date>.csv)
   */
  '--output'?: string
}

Was this section helpful?

Usage

npx shop-minis reports get [options] <report-type> <date>