The Share A Refund Carrier Agreement Optimization API lets you analyze shipping data and simulate contract changes to negotiate better rates. You can develop applications that integrate with Share A Refund to model complex pricing scenarios, benchmark current rates against market data, and generate detailed savings projections.

The following figure shows the relationship between your Share A Refund app, the Share A Refund API, and Carrier Agreement Optimization.

(Insert diagram here)

Figure 1. Share A Refund API relationship diagram.

Share A Refund App

Share A Refund’s optimization services give users the ability to test “what-if” scenarios, compare proposed carrier terms against historical shipping data, and visualize the financial impact of contract adjustments before signing.

Share A Refund API

The REST API that allows users to create optimization projects, run rate simulations, and retrieve savings reports from within your app.

Benchmarking

An app that uses Share A Refund CAO to compare a shipper’s current rates and discounts against an aggregated pool of market data to identify areas for negotiation.

Rate Simulation

A system that recalculates historical shipment costs using proposed contract terms, providing a highly accurate forecast of potential savings or cost increases.

What can users do with the Share A Refund Carrier Agreement Optimization API?

Users can use the Share A Refund CAO API to perform common workflows, such as:

  • Create a new optimization project based on recent shipping history
  • Upload proposed carrier pricing tables and surcharge rules
  • Run simulations to compare “Current” vs. “Proposed” contract terms
  • Generate savings comparison reports broken down by service level
  • Benchmark specific surcharges (e.g., fuel, residential) against market averages
  • Export detailed impact analysis data for stakeholder review



Optimization properties available to create, modify, update and delete through the Share A Refund CAO API:

  • Benchmarks
  • Impact Analysis
  • Proposals
  • Rate Simulations
  • Savings Reports

Additional info

Learn more about developing with Share A Refund CAO 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 CAO API app, read the Developer Getting Started Guide. More