The EPISHIP Reports API allows you to programmatically generate and retrieve detailed business intelligence reports. You can develop applications that utilize predefined “Builders” (templates) and “Writers” (file formats) to create customized reports on shipping summaries, payouts, and product data, delivered asynchronously or via direct download.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Reporting services.
Figure 1. EPISHIP API relationship diagram. Report template selection and file generation flow.
EPISHIP’s reporting dashboard allows users to select from a variety of report types (e.g., Shipping Summary, Payout Details) and configure parameters such as date ranges and file formats (CSV, PDF, XLSX). It serves as the visual interface for initiating these complex data queries.
The REST API that powers the reporting engine. It exposes available “Builders” (templates) and “Writers” (output formats) for a specific company, handles the creation of report jobs, and allows for the retrieval of generated files once processing is complete.
Secured via Bearer tokens in the Authorization header. Access to specific report builders and data is strictly scoped to the authenticated user’s company, ensuring that sensitive financial and operational data is never exposed to unauthorized entities.
The API distinguishes between *what* data to pull (Builders) and *how* to format it (Writers). Common builders include `shipping_summary`, `payout_details`, and `orders`, while writers support standard formats like `csv`, `pdf`, and `xlsx`.
Users can use the EPISHIP Reports API to perform common workflows, such as:
Report properties available to view and filter through the EPISHIP Reports API:
