Overview
The EPISHIP Agreements API lets you retrieve and monitor carrier service agreements associated with your shipping accounts. You can develop applications that integrate with EPISHIP to automate the retrieval of agreement details, filter contracts by carrier, and synchronize agreement IDs with your internal systems.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Agreement services
Figure 1. EPISHIP API relationship diagram. Agreements architecture and request flow.
EPISHIP App
EPISHIP’s agreement services give users the ability to access and audit carrier contracts, ensuring that the correct billing terms and service descriptions are applied to shipments across different Carriers.
EPISHIP API
The REST API that allows users to access agreement resources programmatically from within your app using secure GET requests.
Authentication
A secure method utilizing Bearer tokens in the Authorization header to validate requests, ensuring that only authorized users can view sensitive agreement data.
Agreement Management
A location that maintains a listing of all resource agreements, allowing for the organization of contracts by specific company IDs or carrier networks.
What can users do with the EPISHIP Agreements API?
Users can use the EPISHIP Agreements API to perform common workflows, such as:
- Retrieve a listing of all available agreements
- Filter agreement lists by specific Carrier
- Filter agreement lists by Company ID
- Access specific Agreement IDs and their descriptions
- Validate the existence of specific carrier contracts
Agreement properties available to view and filter through the EPISHIP Agreements API:
- Agreement ID
- Description
- Carrier Name
- Company ID