Overview
- The Share A Refund Report API lets you generate and retrieve detailed analytical documents regarding shipping performance and auditing results. You can develop applications that integrate with Share A Refund to access critical business intelligence, creating summaries of spending, savings, and carrier service quality.
- View Doc →
- The following figure shows the relationship between your Share A Refund app, the Share A Refund API, and Reporting services.
Share A Refund App
Share A Refund’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.
Share A Refund 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 Share A Refund Report API?
Users can use the Share A Refund 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 Share A Refund Report API:
- File Formats
- Parameters
- Report Files
- Templates
- Usage Metrics
Additional info
- Learn more about developing with Share A Refund Report 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 Report API app, read the Developer Getting Started Guide.
- More →
