ShipEngine 2.3.0
See the version list below for details.
dotnet add package ShipEngine --version 2.3.0
NuGet\Install-Package ShipEngine -Version 2.3.0
<PackageReference Include="ShipEngine" Version="2.3.0" />
paket add ShipEngine --version 2.3.0
#r "nuget: ShipEngine, 2.3.0"
// Install ShipEngine as a Cake Addin #addin nuget:?package=ShipEngine&version=2.3.0 // Install ShipEngine as a Cake Tool #tool nuget:?package=ShipEngine&version=2.3.0
ShipEngine .NET SDK
The official ShipEngine SDK for .NET
Quick Start
Install ShipEngine .NET SDK via the .NET CLI.
dotnet add package ShipEngine
The only configuration requirement is an API key.
using ShipEngineSDK;
var shipengine = new ShipEngine("___YOUR_API_KEY_HERE__");
Methods
CreateLabelFromRate
- When retrieving rates for shipments using theGetRatesWithShipmentDetails
method, the returned information contains aRateId
property that can be used to purchase a label without having to refill in the shipment information repeatedly.CreateLabelFromShipmentDetails
- Purchase and print a label for shipment.GetRatesWithShipmentDetails
- Given some shipment details and rate options, this method returns a list of rate quotes.ListCarriers
- Returns a list of carrier accounts that have been connected through the ShipEngine dashboard.TrackUsingLabelId
- Track a package by its associated label ID.TrackUsingCarrierCodeAndTrackingNumber
- Track a package for a given carrier and tracking number.ValidateAddresses
- Indicates whether the provided addresses are valid. If the addresses are valid, the method returns a normalized version based on the standards of the country in which the address resides. If an address cannot be normalized, an error is returned.VoidLabelWithLabelId
- Void a label with its Label ID.CreateManifests
- Create a shipment manifest.
Contributing
Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.
Building
To build the project locally on your computer:
Clone this repo<br>
git clone https://github.com/ShipEngine/shipengine-dotnet.git
Install .NET 5.x
Install dependencies<br>
dotnet restore
Build the code<br>
dotnet build
Format the code<br>
dotnet format
Run the tests<br>
dotnet test
<br><br> By default, the test project targets all supported frameworks, if your environment only supports a subset then you can specify in the CLI. <br><br>dotnet test -f net5.0
Generating from OpenAPI
To regenerate the SDK from the OpenAPI spec, you will first need to get the latest version of the spec. It can be downloaded from the online documentation
and should be saved to ./generation/swagger.json
. Then run npm run generate
from the command line. This will regenerate all the API calls and models, but not docs or tests.
The templates for autogeneration were extracted using the command:
npx @openapitools/openapi-generator-cli author template -g csharp -o generation/templates
Release
Create a fork for your changes.
Update the Changelog with any relevant new features or bug fixes and modify the packageVersion
property in the .openapitools.json
file to match the new version.
In the ShipEngine.csproj
file, update to the desired version (using semantic versioning) and push to your fork.
Run dotnet format
Create a pull request.
Once a member of the ShipEngine team reviews your PR and it's merged to main, the build pipeline will handle all the necessary github tags and nuget packaging and publishing.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Macross.Json.Extensions (>= 3.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Hosting (>= 8.0.0)
- Microsoft.Extensions.Http (>= 8.0.0)
- System.Text.Json (>= 8.0.4)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on ShipEngine:
Package | Downloads |
---|---|
Apsy.Elemental.ECommerce
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
3.0.0-beta.11 | 200 | 8/26/2024 |
3.0.0-beta.10 | 32 | 8/26/2024 |
3.0.0-beta.9 | 915 | 7/28/2024 |
3.0.0-beta.8 | 60 | 7/24/2024 |
3.0.0-beta.7 | 37 | 7/24/2024 |
3.0.0-beta.6 | 46 | 7/23/2024 |
3.0.0-beta.5 | 59 | 7/23/2024 |
3.0.0-beta.4 | 60 | 7/19/2024 |
3.0.0-beta.3 | 56 | 7/17/2024 |
3.0.0-beta.2 | 49 | 7/16/2024 |
3.0.0-beta.1 | 44 | 7/16/2024 |
2.3.0 | 72 | 8/26/2024 |
2.2.1 | 583 | 7/22/2024 |
2.2.0 | 81 | 7/16/2024 |
2.0.5 | 81 | 7/10/2024 |
2.0.4 | 711 | 7/2/2024 |
2.0.3 | 136 | 6/28/2024 |
2.0.2 | 85 | 6/28/2024 |
2.0.1 | 117 | 6/12/2024 |
2.0.0 | 1,247 | 6/5/2024 |
1.1.9 | 1,273 | 5/21/2024 |
1.1.8 | 11,105 | 4/22/2024 |
1.1.7 | 86 | 4/19/2024 |
1.1.6 | 433 | 3/21/2024 |
1.1.5 | 1,742 | 1/12/2024 |
1.1.3 | 2,261 | 10/3/2023 |
1.1.2 | 144 | 9/18/2023 |
1.1.1 | 2,638 | 8/7/2023 |
1.1.0 | 4,504 | 11/10/2022 |
1.0.7 | 2,559 | 11/1/2022 |
1.0.6 | 768 | 10/19/2022 |
1.0.5 | 526 | 9/23/2022 |
1.0.4 | 690 | 6/9/2022 |