Overview
The Share A Refund Shortlinks API lets you create and view shortened URLs that are used for sharing tracking information, proof of delivery documents, and reports. You can develop applications that integrate with Share A Refund to automate the distribution of long, complex URLs into manageable, shareable links.
View Doc: https://app.sharearefund.com/api/doc#api-Agreement →
The following figure shows the relationship between your Share A Refund app, the Share A Refund API, and Agreements.
Figure 1. Share A Refund API relationship diagram.
Share A Refund App
Share A Refund’s agreements services gives users with custom parcel and freight pricing agreements, named My Share A Refund Agreements, and the option to access collaborative agreements.
Share A Refund API
The REST API that allows users to use Agreements from within your app.
Authentication
An app that uses Share A Refund Agreements as a digital artifact of all pricing incentives and rules from within your app.
Collaborative Agreements
A location that maintains all agreement incentives, rules and transformers inherent to individual agreements from inside any given agreement.
What can users do with the Share A Refund Agreements API?
Users can use the Share A Refund Agreements to perform common workflows, such as:
- Clone an agreement as new from existing
- Create an agreement
- Delete an agreement
- Download agreements from Share A Refund, modify and update rules to agreements.
- Integrate your Share A Refund Agreement within your custom application.
- Modify agreement rules, types listed below
- Save an agreement with new name or description
- Update an agreement with rules, modify transformers and change incentives.
Agreement rules available to create, modify, update and delete throught the Share A Refund Agreements API:
Multipiece Minimum Weight Qualifier rules
Service Discount by Region rules
Additional info
Learn more about developing with Share A Refund Agreements 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 Agreements API app, read the Developer Getting Started Guide. More →