AfterShipTracking 7.0.1

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
  • Quick Start
    • Installation
  • Constructor
    • Example
  • Rate Limiter
  • Error Handling
    • Error List
  • Endpoints
    • /trackings
    • /couriers
    • /last_checkpoint
    • /notifications
    • /estimated-delivery-date
  • 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.

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);

            CreateTrackingOptions options = new CreateTrackingOptions();
            options.CreateTrackingRequest = new CreateTrackingRequest();
            TrackingCreateTrackingRequest newTracking = new TrackingCreateTrackingRequest();
            newTracking.TrackingNumber = "<tracking_number>";
            newTracking.Slug = "<slug>";
            options.CreateTrackingRequest.Tracking = newTracking;
            Tracking tracking = client.Tracking.CreateTracking(options);
            if (tracking != null)
            {
                Console.WriteLine(tracking.Id);
            }
        }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 instance has the following properties which are exactly the same as the API endpoints:

• courier - Get a list of our supported couriers.
• tracking - Create trackings, update trackings, and get tracking results.
• last_checkpoint - Get tracking information of the last checkpoint of a tracking.
• notification - Get, add or remove contacts (sms or email) to be notified when the status of a tracking has changed.
• estimated-delivery-date - Get estimated delivery date for your order.

/trackings

POST /trackings

CreateTrackingOptions options = new CreateTrackingOptions();
options.CreateTrackingRequest = new CreateTrackingRequest();
TrackingCreateTrackingRequest newTracking = new TrackingCreateTrackingRequest();
newTracking.TrackingNumber = "<tracking_number>";
newTracking.Slug = "<slug>";
options.CreateTrackingRequest.Tracking = newTracking;
Tracking tracking = client.Tracking.CreateTracking(options);
if (tracking != null)
{
    Console.WriteLine(tracking.Id);
}

DELETE /trackings/:id

DeleteTrackingByIdOptions deleteOptions = new DeleteTrackingByIdOptions();
PartialDeleteTracking resp = client.Tracking.DeleteTrackingById("<tracking_id>");

if (resp != null)
{
    Console.WriteLine(resp.Id);
}

GET /trackings

GetTrackingsOptions options = new GetTrackingsOptions();
options.Keyword = "test";
GetTrackingsResponseTrackingListData trackingsData = client.Tracking.GetTrackings(options);
if (trackingsData != null && trackingsData.Trackings != null)
{
    for (int i = 0; i < trackingsData.Trackings.Length; i++)
    {
        Console.WriteLine(trackingsData.Trackings[i].TrackingNumber);
    }
}

GET /trackings/:id

Tracking tracking = client.Tracking.GetTrackingById("<tracking_id>");
if (tracking != null)
{
   Console.WriteLine(tracking.TrackingNumber);
}

PUT /trackings/:id

UpdateTrackingByIdOptions updateOptions = new UpdateTrackingByIdOptions();
updateOptions.UpdateTrackingByIdRequest = new UpdateTrackingByIdRequest();
TrackingUpdateTrackingByIdRequest trackingToUpdate = new TrackingUpdateTrackingByIdRequest();
trackingToUpdate.Title = "this is a test new title";
trackingToUpdate.Note = "some note";
updateOptions.UpdateTrackingByIdRequest.Tracking = trackingToUpdate;
Tracking tracking = client.Tracking.UpdateTrackingById("<tracking_id>", updateOptions);

if (tracking != null)
{
    Console.WriteLine(tracking.Title);
    Console.WriteLine(tracking.Note);
}

POST /trackings/:id/retrack

RetrackTrackingByIdOptions options = new RetrackTrackingByIdOptions();
PartialUpdateTracking tracking = client.Tracking.RetrackTrackingById("<tracking_id>");
Console.WriteLine(tracking.TrackingNumber);

POST /trackings/:id/mark-as-completed

MarkTrackingCompletedByIdOptions options = new MarkTrackingCompletedByIdOptions();
PartialUpdateTracking tracking = client.Tracking.RetrackTrackingById("<tracking_id>");
Console.WriteLine(tracking.TrackingNumber);

/couriers

GET /couriers

GetUserCouriersOptions options = new GetUserCouriersOptions();
GetUserCouriersResponse resp = client.Courier.GetUserCouriers(options);
Console.WriteLine(resp.Total);

GET /couriers/all

GetAllCouriersOptions options = new GetAllCouriersOptions();
GetAllCouriersResponse resp = client.Courier.GetAllCouriers(options);
Console.WriteLine(resp.Total);

POST /couriers/detect

DetectCourierOptions options = new DetectCourierOptions();
DetectCourierRequest detectCourierRequest = new DetectCourierRequest();
TrackingDetectCourierRequest tracking = new TrackingDetectCourierRequest();
tracking.TrackingNumber = "<tracking_number>";
detectCourierRequest.Tracking = tracking;
options.DetectCourierRequest = detectCourierRequest;
DetectCourierResponse resp = client.Courier.DetectCourier(options);
Console.WriteLine(resp.Total);

/last_checkpoint

GET /last_checkpoint/:id

GetCheckpointByTrackingIdResponse resp = client.LastCheckpoint.GetCheckpointByTrackingId("<tracking_id>");
Console.WriteLine(resp.Slug);

/notifications

GET /notifications/:id

Notification notification =  client.Notification.GetNotificationByTrackingId("<tracking_id>");
Console.WriteLine(notification.Emails[0]);

POST /notifications/:id/add

AddNotificationByTrackingIdOptions options = new AddNotificationByTrackingIdOptions();
AddNotificationByTrackingIdRequest request = new AddNotificationByTrackingIdRequest();
NotificationRequestV1 notification = new NotificationRequestV1();
notification.Emails = new string?[] { "<your_email>" };
request.Notification = notification;
options.AddNotificationByTrackingIdRequest = request;

Notification result = client.Notification.AddNotificationByTrackingId("<tracking_id>", options);
Console.WriteLine(result.Emails[0]);

POST /notifications/:id/remove

DeleteNotificationByTrackingIdOptions options = new DeleteNotificationByTrackingIdOptions();
DeleteNotificationByTrackingIdRequest request = new DeleteNotificationByTrackingIdRequest();
NotificationRequestV1 notification = new NotificationRequestV1();
notification.Emails = new string?[] { "<your_email>" };
request.Notification = notification;
options.DeleteNotificationByTrackingIdRequest = request;

Notification result = client.Notification.DeleteNotificationByTrackingId("<tracking_id>", options);
Console.WriteLine(result.Emails[0]);

/estimated-delivery-date

POST /estimated-delivery-date/predict-batch

PredictBatchOptions options = new PredictBatchOptions();
PredictBatchRequest request = new PredictBatchRequest();

EstimatedDeliveryDateRequest estimatedDeliveryDateRequest = new EstimatedDeliveryDateRequest();

DestinationAddressEstimatedDeliveryDateRequest dest = new DestinationAddressEstimatedDeliveryDateRequest();
dest.Country = "<ISO 3166-1 country/region code>";
dest.State = "<ISO 3166-1 country/region code>";
estimatedDeliveryDateRequest.DestinationAddress = dest;

OriginAddressEstimatedDeliveryDateRequest origin = new OriginAddressEstimatedDeliveryDateRequest();
origin.Country = "<ISO 3166-1 country/region code>";
origin.State = "<ISO 3166-1 country/region code>";
estimatedDeliveryDateRequest.OriginAddress = origin;

estimatedDeliveryDateRequest.Slug = "<slug>";
estimatedDeliveryDateRequest.PickupTime = "2024-08-01 06:42:30";
request.EstimatedDeliveryDates = new EstimatedDeliveryDateRequest[] { estimatedDeliveryDateRequest };

options.PredictBatchRequest = request;

EstimatedPickupEstimatedDeliveryDateRequest r2 = new EstimatedPickupEstimatedDeliveryDateRequest();
r2.BusinessDays = new int?[] { 0 };

PredictBatchResponse resp = client.EstimatedDeliveryDate.PredictBatch(options);
Console.WriteLine(resp.EstimatedDeliveryDates[0].PickupTime);

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) 2024 AfterShip

Licensed under the MIT license.