Overview
- The Optimum Parcel Prospectus API lets you generate and manage value estimation reports for potential clients. You can develop applications that integrate with Optimum Parcel to analyze sample shipping data, calculate projected savings, and create professional proposals that demonstrate the financial benefit of the service.
- View Doc →
- The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and Prospectus services.
Optimum Parcel App
Optimum Parcel’s prospectus services give users the ability to produce data-driven sales tools, allowing teams to present accurate savings forecasts and secure customer trust through transparent analysis.
Optimum Parcel API
The REST API that allows users to create new prospectus records, process sample datasets, and retrieve finished proposal documents from within your app.
Value Projection
A system that analyzes historical shipping patterns to estimate potential refund opportunities in order to provide a realistic forecast of recoverable revenue.
Proposal Generation
A mechanism that compiles analysis results into a structured document, detailing service terms, estimated ROI, and implementation steps for the prospective merchant.
What can users do with the Optimum Parcel Prospectus API?
Users can use the Optimum Parcel Prospectus API to perform common workflows, such as:
- Create a new prospectus for a prospective client
- Upload sample shipping files for analysis
- Trigger a savings calculation based on current audit logic
- Retrieve a summary of projected savings by carrier and service typeIdentify specific surcharges applied to a shipment
- Download a PDF version of the formal proposal
- Track the status of open proposals
Prospectus properties available to create, modify, update and delete through the Optimum Parcel Prospectus API:
- Client Details
- Proposals
- Sample Datasets
- Savings Estimates
- Status Flags
Additional info
- Learn more about developing with Optimum Parcel Prospectus 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 Prospectus API app, read the Developer Getting Started Guide.
- More →
