Overview
- The Optimum Parcel Shipment API lets you retrieve and analyze comprehensive data on individual packages. You can develop applications that integrate with Optimum Parcel to track shipment progress, verify service level adherence, and audit specific charges associated with a tracking number.
- View Doc →
- The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and Shipment services.
Optimum Parcel App
Optimum Parcel’s shipment services give users granular visibility into their logistics operations, allowing for the detailed inspection of weight, dimensions, zones, and delivery timestamps for every package.
Optimum Parcel API
The REST API that allows users to search for shipments, retrieve full tracking history, and access audit details from within your app.
Tracking Analysis
A system that logs every scan event during transit to provide a complete timeline from pickup to final delivery to identify delays or exceptions.
Charge Verification
A mechanism that breaks down total shipping costs into base rates and individual surcharges, enabling the validation of billing accuracy against the carrier agreement.
What can users do with the Optimum Parcel Shipment API?
Users can use the Optimum Parcel Shipment API to perform common workflows, such as:
- Search for a shipment by tracking number or reference ID
- Retrieve detailed package dimensions and weight data
- View the complete scan history and proof of delivery
- Identify specific surcharges applied to a shipment
- Check the audit status of a package for potential refunds
- Access zone and service type information
Shipment properties available to view, query, and analyze through the Optimum Parcel Shipment API:
- Audit Results
- Dimensions
- Scan History
- Surcharges
- Tracking Details
Additional info
- Learn more about developing with Optimum Parcel Shipment 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 Shipment API app, read the Developer Getting Started Guide.
- More →
