AfterShipTracking 15.0.0

AfterShip Tracking API library for C#

This library allows you to quickly and easily use the AfterShip Tracking API via C#.

For updates to this library, see our GitHub release page.

If you need support using AfterShip products, please contact support@aftership.com.

Table of Contents

• AfterShip Tracking API library for C#
  • Table of Contents
  • Before you begin
    • API and SDK Version
  • Quick Start
    • Installation
  • Constructor
    • Example
  • Rate Limiter
  • Error Handling
    • Error List
  • Endpoints
    • /couriers
    • /courier-connections
    • /estimated-delivery-date
    • /trackings
  • Help
  • License

Before you begin

Before you begin to integrate:

• Create an AfterShip account.
• Create an API key.
• Install .Net version 6.0 or later.

API and SDK Version

• SDK Version: 15.0.0
• API Version: 2026-01

Quick Start

Installation

Using the [.NET Core command-line interface (CLI) tools]:

dotnet add package AfterShipTracking

Using the [NuGet Command Line Interface (CLI)]:

nuget install AfterShipTracking

From within Visual Studio:

1. Open the Solution Explorer.
2. Right-click on a project within your solution.
3. Click on Manage NuGet Packages...
4. Click on the Browse tab and search for "AfterShipTracking".
5. Click on the AfterShipTracking package, select the appropriate version in the right-tab and click Install.

For with Visual Studio Code:

1. Open the Command Palette then type "NuGet Package Manager"
2. In the opened window, search for "AfterShipTracking".
3. Select the AfterShipTracking package and the package version.

Constructor

Create AfterShip instance with options

Example

using AfterShipTracking;
class Program
{
    static void Main()
    {
        try
        {
            AfterShipClient client = new AfterShipClient(
                apiKey: "YOUR_API_KEY",
                apiSecret: "YOUR_AES_SECRET",
                authenticationType: AfterShipConfiguration.AUTHENTICATION_TYPE_AES
            );

            GetTrackingByIdOptions options = new GetTrackingByIdOptions();
                GetTrackingByIdResponse response = client.Tracking.GetTrackingById("valid_value",options);
                if (response != null)
                {
                    Console.WriteLine(response);
                }
        } catch (Exception e)
        {
            Console.WriteLine(e.Message);
        }
    }
}

Rate Limiter

See the Rate Limit to understand the AfterShip rate limit policy.

Error Handling

The SDK will return an error object when there is any error during the request, with the following specification:

Error List

Endpoints

The AfterShip SDK has the following resource which are exactly the same as the API endpoints:

• CourierResource
  • Get couriers
  • Detect courier
• CourierConnectionResource
  • Get courier connections
  • Create courier connections
  • Get courier connection by id
  • Update courier connection by id
  • Delete courier connection by id
• EstimatedDeliveryDateResource
  • Prediction for the Estimated Delivery Date
  • Batch prediction for the Estimated Delivery Date
• TrackingResource
  • Get trackings
  • Create a tracking
  • Get a tracking by ID
  • Update a tracking by ID
  • Delete a tracking by ID
  • Retrack an expired tracking by ID
  • Mark tracking as completed by ID

/couriers

GET /couriers

    GetCouriersOptions options = new GetCouriersOptions();
    GetCouriersResponse response = client.Courier.GetCouriers(options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

POST /couriers/detect

    DetectCourierOptions options = new DetectCourierOptions();
    DetectCourierRequest detectCourierRequest = new DetectCourierRequest();
    detectCourierRequest.TrackingNumber = "valid_value";
    options.DetectCourierRequest = detectCourierRequest;
    DetectCourierResponse response = client.Courier.DetectCourier(options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

/courier-connections

GET /courier-connections

    GetCourierConnectionsOptions options = new GetCourierConnectionsOptions();
    GetCourierConnectionsResponse response = client.CourierConnection.GetCourierConnections(options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

POST /courier-connections

    PostCourierConnectionsOptions options = new PostCourierConnectionsOptions();
    PostCourierConnectionsRequest postCourierConnectionsRequest = new PostCourierConnectionsRequest();
    postCourierConnectionsRequest.CourierSlug = "valid_value";
    postCourierConnectionsRequest.Credentials = new Dictionary<string, string>();
    options.PostCourierConnectionsRequest = postCourierConnectionsRequest;
    PostCourierConnectionsResponse response = client.CourierConnection.PostCourierConnections(options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

GET /courier-connections/{id}

    GetCourierConnectionsByIdOptions options = new GetCourierConnectionsByIdOptions();
    GetCourierConnectionsByIdResponse response = client.CourierConnection.GetCourierConnectionsById("valid_value",options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

PATCH /courier-connections/{id}

    PutCourierConnectionsByIdOptions options = new PutCourierConnectionsByIdOptions();
    PutCourierConnectionsByIdRequest putCourierConnectionsByIdRequest = new PutCourierConnectionsByIdRequest();
    putCourierConnectionsByIdRequest.Credentials = new Dictionary<string, string>();
    options.PutCourierConnectionsByIdRequest = putCourierConnectionsByIdRequest;
    PutCourierConnectionsByIdResponse response = client.CourierConnection.PutCourierConnectionsById("valid_value",options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

DELETE /courier-connections/{id}

    DeleteCourierConnectionsByIdOptions options = new DeleteCourierConnectionsByIdOptions();
    DeleteCourierConnectionsByIdResponse response = client.CourierConnection.DeleteCourierConnectionsById("valid_value",options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

/estimated-delivery-date

POST /estimated-delivery-date/predict

    PredictOptions options = new PredictOptions();
    EstimatedDeliveryDateRequest predictRequest = new EstimatedDeliveryDateRequest();
    predictRequest.Slug = "valid_value";
    EstimatedDeliveryDateRequestOriginAddress originAddress = new EstimatedDeliveryDateRequestOriginAddress();
    predictRequest.OriginAddress = originAddress;
    EstimatedDeliveryDateRequestDestinationAddress destinationAddress = new EstimatedDeliveryDateRequestDestinationAddress();
    predictRequest.DestinationAddress = destinationAddress;
    options.PredictRequest = predictRequest;
    PredictResponse response = client.EstimatedDeliveryDate.Predict(options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

POST /estimated-delivery-date/predict-batch

    PredictBatchOptions options = new PredictBatchOptions();
    PredictBatchRequest predictBatchRequest = new PredictBatchRequest();
    options.PredictBatchRequest = predictBatchRequest;
    PredictBatchResponse response = client.EstimatedDeliveryDate.PredictBatch(options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

/trackings

GET /trackings

    GetTrackingsOptions options = new GetTrackingsOptions();
    GetTrackingsResponse response = client.Tracking.GetTrackings(options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

POST /trackings

    CreateTrackingOptions options = new CreateTrackingOptions();
    CreateTrackingRequest createTrackingRequest = new CreateTrackingRequest();
    createTrackingRequest.TrackingNumber = "valid_value";
    options.CreateTrackingRequest = createTrackingRequest;
    CreateTrackingResponse response = client.Tracking.CreateTracking(options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

GET /trackings/{id}

    GetTrackingByIdOptions options = new GetTrackingByIdOptions();
    GetTrackingByIdResponse response = client.Tracking.GetTrackingById("valid_value",options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

PUT /trackings/{id}

    UpdateTrackingByIdOptions options = new UpdateTrackingByIdOptions();
    UpdateTrackingByIdRequest updateTrackingByIdRequest = new UpdateTrackingByIdRequest();
    options.UpdateTrackingByIdRequest = updateTrackingByIdRequest;
    UpdateTrackingByIdResponse response = client.Tracking.UpdateTrackingById("valid_value",options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

DELETE /trackings/{id}

    DeleteTrackingByIdOptions options = new DeleteTrackingByIdOptions();
    DeleteTrackingByIdResponse response = client.Tracking.DeleteTrackingById("valid_value",options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

POST /trackings/{id}/retrack

    RetrackTrackingByIdOptions options = new RetrackTrackingByIdOptions();
    RetrackTrackingByIdResponse response = client.Tracking.RetrackTrackingById("valid_value",options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

POST /trackings/{id}/mark-as-completed

    MarkTrackingCompletedByIdOptions options = new MarkTrackingCompletedByIdOptions();
    MarkTrackingCompletedByIdRequest markTrackingCompletedByIdRequest = new MarkTrackingCompletedByIdRequest();
    options.MarkTrackingCompletedByIdRequest = markTrackingCompletedByIdRequest;
    MarkTrackingCompletedByIdResponse response = client.Tracking.MarkTrackingCompletedById("valid_value",options);
    if (response != null)
    {
        Console.WriteLine(response);
    }

Help

If you get stuck, we're here to help:

• Issue Tracker for questions, feature requests, bug reports and general discussion related to this package. Try searching before you create a new issue.
• Contact AfterShip official support via support@aftership.com

License

Copyright (c) 2025 AfterShip

Licensed under the MIT license.