Overview
The EPISHIP Report Schedules API allows you to programmatically automate the generation and delivery of business reports. You can develop applications that create recurring schedules for shipping summaries, financial statements, and operational metrics, ensuring stakeholders receive timely data without manual intervention.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Report Scheduling services.
Figure 1. EPISHIP API relationship diagram. Automated report generation and distribution flow.
EPISHIP App
EPISHIP’s reporting interface provides a user-friendly way to configure recurring tasks. Users can select report types (e.g., Shipping Summary), define the frequency (e.g., Weekly on Monday), and specify recipients, ensuring that critical business intelligence is delivered automatically.
EPISHIP API
The REST API that manages the lifecycle of report schedules. It enables the creation, update, and deletion of schedules, as well as the retrieval of existing configurations. It supports various output formats like CSV and integrates with the job queue for execution.
Authentication
Secured via Bearer tokens in the Authorization header. Access to report schedules is scoped to the specific Company ID and User ID, ensuring that sensitive reporting configurations and data are protected from unauthorized access.
Scheduling Logic
A flexible system for defining when reports should run. Schedules can be configured with a `period` (e.g., weekly), specific `period_week_day` (e.g., Monday), and file formats (e.g., CSV). This ensures reports are generated exactly when needed for business reviews.
What can users do with the EPISHIP Report Schedules API?
Users can use the EPISHIP Report Schedules API to perform common workflows, such as:
- Retrieve a list of all active report schedules for a company
- Create new recurring report schedules for specific report types
- Update existing schedules to change frequency, recipients, or formats
- Delete obsolete schedules to stop unnecessary report generation
- View detailed settings of a specific schedule by ID
Report Schedule properties available to view and filter through the EPISHIP Report Schedules API:
- Schedule ID
- Report Name and Title
- Frequency (Period, Day of Week)
- File Type (CSV, PDF)
- Associated User and Company IDs
- Last Executed Timestamp