ShipEngine 2.2.0

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package ShipEngine --version 2.2.0                
NuGet\Install-Package ShipEngine -Version 2.2.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ShipEngine" Version="2.2.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ShipEngine --version 2.2.0                
#r "nuget: ShipEngine, 2.2.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ShipEngine as a Cake Addin
#addin nuget:?package=ShipEngine&version=2.2.0

// Install ShipEngine as a Cake Tool
#tool nuget:?package=ShipEngine&version=2.2.0                

ShipEngine

ShipEngine .NET SDK

The official ShipEngine SDK for .NET

Nuget (with prereleases) GitHub

Build Status Coverage Status

OS Compatibility

Nuget Page

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 the GetRatesWithShipmentDetails method, the returned information contains a RateId 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:

  1. Clone this repo<br> git clone https://github.com/ShipEngine/shipengine-dotnet.git

  2. Install .NET 5.x

  3. Install dependencies<br> dotnet restore

  4. Build the code<br> dotnet build

  5. Format the code<br> dotnet format

  6. 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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.3 27 7/17/2024
3.0.0-beta.2 34 7/16/2024
3.0.0-beta.1 31 7/16/2024
2.2.0 61 7/16/2024
2.0.5 63 7/10/2024
2.0.4 176 7/2/2024
2.0.3 129 6/28/2024
2.0.2 81 6/28/2024
2.0.1 114 6/12/2024
2.0.0 625 6/5/2024
1.1.9 775 5/21/2024
1.1.8 6,989 4/22/2024
1.1.7 84 4/19/2024
1.1.6 395 3/21/2024
1.1.5 1,486 1/12/2024
1.1.3 2,079 10/3/2023
1.1.2 143 9/18/2023
1.1.1 2,329 8/7/2023
1.1.0 4,457 11/10/2022
1.0.7 2,555 11/1/2022
1.0.6 765 10/19/2022
1.0.5 521 9/23/2022
1.0.4 682 6/9/2022