The Shipping APIs include a variety of operations that allow users to manage and track their shipping requests.
Some of the key API operations available in the Shipping API includes:
| Operation | Description |
|---|---|
| Get Carriers | The operation fetches all onboarded carriers. Typically, user will use this service to get list of onboarded carriers and supported properties for those carriers. |
| Get Countries | The operation fetches list of supported destination countries for a provided carrier and origin country. |
| Get Services | The operation fetches a list of supported services for a carrier with respect to specific origin and destination country. |
| Get ParcelTypes | The operation fetches ParcelTypes based on carrier, origin, and destination country. |
| Get Special Services | The operation fetches Special Services for a given carrier, service, origin, and destination country. |
| Get Carrier Accounts | The operation retrieves onboarded Carriers with their Carrier Account Ids which uniquely identify multiple accounts of same carrier. |
| Rate Shop and Get Single Rate | This API contains 2 operations, rate shop and single rate. Rate shop will fetch rates for all carrier services based on the given addresses (From and To), weight, and dimension for given parcelType. Single rate will get rate for specific service and special service (if requested) based on the given addresses (From and To), weight, and dimension, parcelType and serviceId with or without specialServices. Single rate will be used to rate a shipment before creating it. |
| Create Shipment | The operation creates a new Shipment or Shipment Label. This is for both Domestic and International. |
| Get All Shipments | The operation fetches all created Shipments. |
| Get Shipment by Id | Retrieves single shipment using Shipment Id. |
| Reprint Shipment | The operation reprints Shipment by the shipmentId. It retrieves an existing shipping label to reprint. The API sends the shipmentId returned by the original Created Shipment request. Use this only if the shipping label in the ‘Create Shipment’ response is missing or lost. |
| Cancel Shipment | The operation cancels previously created shipment. |