Overview
- The Share A Refund Prospectus API lets you generate and manage value estimation reports for potential clients. You can develop applications that integrate with Share A Refund 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 Share A Refund app, the Share A Refund API, and Prospectus services.
Share A Refund App
Share A Refund’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.
Share A Refund 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 Share A Refund Prospectus API?
Users can use the Share A Refund 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 Share A Refund Prospectus API:
- Client Details
- Proposals
- Sample Datasets
- Savings Estimates
- Status Flags
Additional info
- Learn more about developing with Share A Refund Prospectus API, including handling authentication, authorization, reference the Develop on Share A Refund API for your workspace.
- More →
- Learn more about how to launch and run a Share A Refund Prospectus API app, read the Developer Getting Started Guide.
- More →
