Overview
- The Optimum Parcel Report API lets you generate and retrieve detailed analytical documents regarding shipping performance and auditing results. You can develop applications that integrate with Optimum Parcel to access critical business intelligence, creating summaries of spending, savings, and carrier service quality.
- View Doc →
- The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and Reporting services.
Optimum Parcel App
Optimum Parcel’s reporting services give users access to a library of pre-built and custom reports, allowing stakeholders to view data in structured formats such as PDF or CSV for offline analysis and presentation.
Optimum Parcel API
The REST API that allows users to request report generation, define parameters, and download the result files from within your app.
Data Synthesis
A system that compiles raw shipping and billing data into readable summaries to highlight key metrics like total spend, refund totals and zone usage.
Format Management
A mechanism that converts analytical data into various standard file formats to ensure compatibility with external accounting software and presentation tools.
What can users do with the Optimum Parcel Report API?
Users can use the Optimum Parcel Report API to perform common workflows, such as:
- Generate a new report based on specific date ranges
- List all available report types and templates
- Download completed reports in PDF or CSV format
- Retrieve metadata about past generated reports
- Customize report parameters for specific carriers or accounts
- Delete old report files to maintain data hygiene
Report properties available to create, view, and manage through the Optimum Parcel Report API:
- File Formats
- Parameters
- Report Files
- Templates
- Usage Metrics
Additional info
- Learn more about developing with Optimum Parcel Report API, including handling authentication, authorization, reference the Develop on Optimum Parcel API for your workspace.
- More →
- Learn more about how to launch and run a Optimum Parcel Report API app, read the Developer Getting Started Guide.
- More →
