Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexeybusygin/ShippingRates
.NET wrapper for UPS, FedEx, USPS and DHL shipping rate APIs
https://github.com/alexeybusygin/ShippingRates
dhl dhl-ecommerce dotnet dotnet-standard fedex shipping shipping-rates ups usps
Last synced: 7 days ago
JSON representation
.NET wrapper for UPS, FedEx, USPS and DHL shipping rate APIs
- Host: GitHub
- URL: https://github.com/alexeybusygin/ShippingRates
- Owner: alexeybusygin
- License: mit
- Created: 2020-02-15T15:34:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T20:15:34.000Z (about 1 month ago)
- Last Synced: 2024-11-05T22:14:35.585Z (10 days ago)
- Topics: dhl, dhl-ecommerce, dotnet, dotnet-standard, fedex, shipping, shipping-rates, ups, usps
- Language: C#
- Homepage:
- Size: 407 KB
- Stars: 46
- Watchers: 7
- Forks: 15
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
README
# ShippingRates
[](https://ci.appveyor.com/project/alexeybusygin/shippingrates/)
[](https://www.nuget.org/packages/ShippingRates)
.NET wrapper for UPS, FedEx, USPS, and DHL APIs. Use it to retrieve shipping rates from these carriers.
## UPS Breaking Changes
UPS has deprecated access key authentication in favor of an OAuth 2.0 security model for all APIs. Beginning August 5, 2024, access keys will no longer be supported. More details at the UPS site: https://developer.ups.com/oauth-developer-guide?loc=en_US
The new authentication model has been implemented in the package since version 2.1.0.
## How to Install
Available in the [NuGet Gallery](http://nuget.org/packages/ShippingRates):
```
PM> Install-Package ShippingRates
```
## Getting Started
```CSharp
// Create RateManager
using var httpClient = new HttpClient();
var rateManager = new RateManager();
// Add desired shipping providers
// You will need an OAuth Client ID, Client Secret, and Account Number to use the UPS provider.
var upsConfiguration = new UPSProviderConfiguration()
{
ClientId = upsClientId,
ClientSecret = upsClientSecret,
AccountNumber = upsAccountNumber,
UseProduction = false
};
rateManager.AddProvider(new UPSProvider(upsConfiguration, httpClient));
// You will need an account # and meter # to utilize the FedEx provider.
rateManager.AddProvider(new FedExProvider(fedexKey, fedexPassword, fedexAccountNumber, fedexMeterNumber));
// You will need a userId to use the USPS provider. Your account will also need access to the production servers.
rateManager.AddProvider(new USPSProvider(new USPSProviderConfiguration(uspsUserId), httpClient));
// You will need a Site ID and Password to use the DHL provider.
var dhlConfiguration = new DHLProviderConfiguration(dhlSiteId, dhlPassword, useProduction: false));
rateManager.AddProvider(new DHLProvider(dhlConfiguration, httpClient));
// Setup package and destination/origin addresses
var packages = new List();
packages.Add(new Package(12, 12, 12, 35, 150)); // Package in lbs and inches
packages.Add(new PackageKgCm(4, 4, 6, 15, 250)); // Package in kg and cm
var origin = new Address("", "", "06405", "US");
var destination = new Address("", "", "20852", "US"); // US Address
// Call GetRates()
Shipment shipment = await rateManager.GetRatesAsync(origin, destination, packages);
// Iterate through the rates returned
foreach (Rate rate in shipment.Rates)
{
Console.WriteLine(rate);
}
```
See the sample app in this repository for a working example.
## Documentation in [Wiki](https://github.com/alexeybusygin/ShippingRates/wiki)
* [HttpClient lifecycle](https://github.com/alexeybusygin/ShippingRates/wiki/HttpClient-lifecycle)
* [Negotiated Rates](https://github.com/alexeybusygin/ShippingRates/wiki/Negotiated-Rates)
* [USPS: International Rates](https://github.com/alexeybusygin/ShippingRates/wiki/USPS-International-Rates)
* [USPS: Special Services](https://github.com/alexeybusygin/ShippingRates/wiki/USPS-Special-Services)
* [Single Rate for UPS and USPS](https://github.com/alexeybusygin/ShippingRates/wiki/Single-Rate-for-UPS-and-USPS)
* [Rate Adjusters](https://github.com/alexeybusygin/ShippingRates/wiki/Rate-Adjusters)
## Shipping Options
Shipping options can be passed to the `GetRates` function as a `ShipmentOptions` object.
```CSHARP
var shipment = await rateManager.GetRatesAsync(origin, destination, packages,
new ShipmentOptions() {
SaturdayDelivery = true,
ShippingDate = new DateTime(2020, 7, 15),
PreferredCurrencyCode = "EUR", // For FedEx only
FedExOneRate = true, // For FedEx only
FedExOneRatePackageOverride = "FEDEX_ENVELOPE" // For FedEx only
});
```
The following options are available:
| Name | Default Value | Meaning |
| ---- | ------------- | ------- |
| SaturdayDelivery | False | Enable the Saturday Delivery option for shipping rates. |
| ShippingDate | null | Pickup date. The current date and time are used if not specified. |
| PreferredCurrencyCode | USD | Preferred rates currency code in the ISO format. Applies to FedEx only. |
| FedExOneRate | False | Use the FedEx One Rate pricing option. Applies to FedEx only. |
| FedExOneRatePackageOverride | FEDEX_MEDIUM_BOX | Packing option when using FedEx OneRate. |
### Saturday Delivery
If `ShipmentOptions.SaturdayDelivery` is set, you can expect to receive some Saturday Delivery methods. You can check it with the `Rate.Options.SaturdayDelivery` property:
```CSHARP
var anySaturdayDeliveryMethods = shipment.Rates.Any(r => r.Options.SaturdayDelivery);
```
## Error Handling
Normally `RateManager.GetRates` wouldn't throw any exceptions. All errors are caught and reported in two properties: `Errors` and `InternalErrors`. `Errors` are for errors coming from APIs (incorrect address etc.) It should be quite safe to show them to the end user. `InternalErrors` are errors that occur during API calls processing (SOAP, HTTP requests) and errors from inside the ShippingRates. They can be used for debugging and internal reporting. Iterating through Errors and InternalErrors:
```CSHARP
var shipment = rateManager.GetRates(origin, destination, packages);
foreach (var error in shipment.Errors)
{
Console.WriteLine(error.Number);
Console.WriteLine(error.Source);
Console.WriteLine(error.Description);
}
foreach (var error in shipment.InternalErrors)
{
Console.WriteLine(error);
}
```
#### FedEx and 556 There are no valid services available
This one can be tricky to debug. Start by setting at least $1 insurance for your shipment. For some reason, FedEx will not report errors like the wrong ZIP code for the origin address if no insurance is set.
## 3rd Party Docs
Developer documentation is often hard to find. The links below are provided as reference.
* [FedEx](http://www.fedex.com/us/developer/)
* [USPS](https://www.usps.com/business/web-tools-apis/welcome.htm)
* [UPS](https://developer.ups.com/api/reference?loc=en_US#operation/Rate)
* [DHL](https://xmlportal.dhl.com/capability_and_qoute#cap_quote)
## Credits
Originally forked from [DotNetShipping](https://github.com/kylewest/DotNetShipping) by [@kylewest](https://github.com/kylewest).
Package icon by [Fredy Sujono](https://www.iconfinder.com/freud).