The Share A Refund List Agreements API lets you view agreements that use agreements for billing, compliance and modeling. You can develop applications that integration with Share A Refund and create extended functionality in your application using the Share A Refund API.
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’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.
The REST API that allows users to use Agreements from within your app.
An app that uses Share A Refund Agreements as a digital artifact of all pricing incentives and rules from within your app.
A location that maintains all agreement incentives, rules and transformers inherent to individual agreements from inside any given agreement.
Users can use the Share A Refund Agreements to perform common workflows, such as:
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
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
Data Transformer rules
Dim Divisor rules
Earned Discount rules
Fuel Surcharge Discount rules
Grace Period Discount rules
Minimum Net Charge rules
Service Discount rules
Surcharge Net Rate rules
Surcharge Discount rules