Overview
- The Optimum Parcel Agreements API lets you view agreements for billing, compliance and modeling. You can develop applications that integrate with Optimum Parcel and create extended functionality in your application with the Optimum Parcel API.
- View Doc →
The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and Agreements.
Optimum Parcel App
Optimum Parcel’s agreements services gives users with custom parcel and freight pricing agreements, named My Optimum Parcel Agreements, and the option to access collaborative agreements.
Optimum Parcel API
The REST API that allows users to use Agreements from within your app.
Authentication
An app that uses Optimum Parcel 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 Optimum Parcel Agreements API?
Users can use the Optimum Parcel Agreements to perform common workflows, such as:
- Clone an agreement as new from existing
- Create an agreement
- Delete an agreement
- Download agreements from Optimum Parcel, modify and update rules to agreements.
- Integrate your Optimum Parcel 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 Optimum Parcel Agreements API:
- Data Transformer rules
- Dim Divisor rules
- Earned Discount rules
- Fuel Surcharge Discount rules
- Grace Period Discount rules
- Minimum Net Charge rules
- Multipiece Minimum Weight Qualifier rules
- Service Discount by Region rules
- Service Discount rules
- Service Net Rate rules
- Surcharge Net Rate rules
- Surcharge Discount rules
Additional info
- Learn more about developing with Optimum Parcel Agreements API, including handling authentication, authorization, reference the Develop on Optimum Parcel API for your workspace.
- More →
- Learn more about how to launch and run a Optimum Parcel Agreements API app, read the Developer Getting Started Guide.
- More →
