trackingmore-sdk-net

The .Net SDK of TrackingMore API

Contact: [email protected]

Official document

Document

Index

1. Installation
2. Testing
3. Error Handling
4. SDK
   1. Couriers
   2. Trackings
   3. Air Waybill

Installation

Downloading the NuGet package using the dotnet CLI

$ dotnet add package trackingmore

Downloading NuGet Packages with the NuGet Command Line Tool

$ nuget install trackingmore

The difference with dotnet cli is that you need to manually modify the .csproj file and add the following code

<ItemGroup>
    <PackageReference Include="TrackingMore" Version="0.1.2" />
</ItemGroup>

Quick Start

using TrackingMoreAPI;
using TrackingMoreAPI.Model.Couriers;
using TrackingMoreAPI.Model.AirWaybills;
using TrackingMoreAPI.Model.Trackings;

namespace Testing;

public class Test
{

      static void Main(string[] args)
      {
        try
        {
            string apiKey = "your api key";
            TrackingMore trackingMore = new TrackingMore(apiKey);

            var apiResponse = trackingMore.Courier.GetAllCouriers();
            Console.WriteLine(apiResponse.meta.code);
            foreach (var item in apiResponse.data)
            {
                Console.WriteLine("courierName: " + item.courierName);
                Console.WriteLine("courierCode: " + item.courierCode);
                Console.WriteLine();
            }
        }
        catch (TrackingMoreException ex)
        {
            Console.WriteLine("Catch custom exceptions：" + ex.Message);
        }
        catch (TimeoutException ex)
        {
            Console.WriteLine("Timeout Exception: "  + ex.Message);
        }
        catch (Exception ex)
        {
            Console.WriteLine("Catch other exceptions:" + ex.Message);
        }

      }

}

Testing

In the root directory of the test project, run the following command to execute the test

dotnet test

Error handling

Throw by the new SDK client

try
{
    string apiKey = "";
    TrackingMore trackingMore = new TrackingMore(apiKey);
}
catch (TrackingMoreException ex)
{
    Console.WriteLine("Catch custom exceptions：" + ex.Message);
}

# API Key is missing

Throw by the parameter validation in function

try
{
    string apiKey = "your api key";
    TrackingMore trackingMore = new TrackingMore(apiKey);

    DetectParams detectParams = new DetectParams();
    detectParams.trackingNumber = "";
    var apiResponse = trackingMore.Courier.detect(detectParams);
}
catch (TrackingMoreException ex)
{
    Console.WriteLine("Catch custom exceptions：" + ex.Message);
}

# Tracking number cannot be empty

Examples

Couriers

Return a list of all supported couriers.

https://api.trackingmore.com/v4/couriers/all

var apiResponse = trackingMore.Courier.GetAllCouriers();
Console.WriteLine(apiResponse.meta.code);
foreach (var item in apiResponse.data)
{
    Console.WriteLine("courierName: " + item.courierName);
    Console.WriteLine("courierCode: " + item.courierCode);
    Console.WriteLine();
}

Return a list of matched couriers based on submitted tracking number.

https://api.trackingmore.com/v4/couriers/detect

DetectParams detectParams = new DetectParams();
detectParams.trackingNumber = "9261290306531704519171";
var apiResponse = trackingMore.Courier.detect(detectParams);
Console.WriteLine(apiResponse.meta.code);
foreach (var item in apiResponse.data)
{
    Console.WriteLine("courierName: " + item.courierName);
    Console.WriteLine("courierCode: " + item.courierCode);
    
    Console.WriteLine();
}

Trackings

Create a tracking.

https://api.trackingmore.com/v4/trackings/create

CreateTrackingParams createTrackingParams = new CreateTrackingParams();
createTrackingParams.trackingNumber = "9261290306531704519171";
createTrackingParams.courierCode = "usps";
var apiResponse = trackingMore.Tracking.CreateTracking(createTrackingParams);
Console.WriteLine(apiResponse.meta.code);
Console.WriteLine(apiResponse.data.trackingNumber);
Console.WriteLine(apiResponse.data.courierCode);

Get tracking results of multiple trackings.

https://api.trackingmore.com/v4/trackings/get

GetTrackingResultsParams getTrackingResultsParams = new GetTrackingResultsParams();
getTrackingResultsParams.trackingNumbers = "9261290306531704519171,92612903029511573030094547";
getTrackingResultsParams.courierCode = "usps";
getTrackingResultsParams.createdDateMin = "2023-10-09T06:00:00+00:00";
getTrackingResultsParams.createdDateMax = "2023-10-10T13:45:00+00:00";
var apiResponse = trackingMore.Tracking.GetTrackingResults(getTrackingResultsParams);
Console.WriteLine(apiResponse.meta.code);
foreach (var item in apiResponse.data)
{
    Console.WriteLine("trackingNumber: " + item.trackingNumber);
    Console.WriteLine("courierCode: " + item.courierCode);
    
    Console.WriteLine();
}

Create multiple trackings (Max. 40 tracking numbers create in one call).

https://api.trackingmore.com/v4/trackings/batch

List<CreateTrackingParams> trackingParamsList = new List<CreateTrackingParams>();

CreateTrackingParams trackingParams1 = new CreateTrackingParams
{
    trackingNumber = "9261290306531704519172",
    courierCode = "usps"
};

trackingParamsList.Add(trackingParams1);

CreateTrackingParams trackingParams2 = new CreateTrackingParams
{
    trackingNumber = "9261290306531704519174",
    courierCode = "usps"
};

trackingParamsList.Add(trackingParams2);
var apiResponse = trackingMore.Tracking.BatchCreateTrackings(trackingParamsList);
Console.WriteLine(apiResponse.meta.code);
foreach (var item in apiResponse.data.success)
{
    Console.WriteLine("trackingNumber: " + item.trackingNumber);
    Console.WriteLine("courierCode: " + item.courierCode);
    
    Console.WriteLine();
}

foreach (var item in apiResponse.data.error)
{
    Console.WriteLine("trackingNumber: " + item.trackingNumber);
    Console.WriteLine("courierCode: " + item.courierCode);
    
    Console.WriteLine();
}

Update a tracking by ID.

https://api.trackingmore.com/v4/trackings/update/{id}

UpdateTrackingParams updateTrackingParams = new UpdateTrackingParams();
updateTrackingParams.customerName = "New name";
updateTrackingParams.note = "New tests order note";
string idString = "9a557acc90dd57df78933fcc09ab9657";
var apiResponse = trackingMore.Tracking.UpdateTrackingByID(idString, updateTrackingParams);
Console.WriteLine(apiResponse.meta.code);
if(apiResponse.data != null){
    Console.WriteLine(apiResponse.data.trackingNumber);
    Console.WriteLine(apiResponse.data.courierCode);
    Console.WriteLine(apiResponse.data.customerName);
    Console.WriteLine(apiResponse.data.note);
}

Delete a tracking by ID.

https://api.trackingmore.com/v4/trackings/delete/{id}

string idString = "9a5575a8b14833ff3a34d357709707b7";
var apiResponse = trackingMore.Tracking.DeleteTrackingByID(idString);
Console.WriteLine(apiResponse.meta.code);
if(apiResponse.data != null){
    Console.WriteLine(apiResponse.data.trackingNumber);
    Console.WriteLine(apiResponse.data.courierCode);
}

Retrack expired tracking by ID.

https://api.trackingmore.com/v4/trackings/retrack/{id}

string idString = "9a5575a8b14833ff3a34d357709707b7";
var apiResponse = trackingMore.Tracking.RetrackTrackingByID(idString);
Console.WriteLine(apiResponse.meta.code);
if(apiResponse.data != null){
    Console.WriteLine(apiResponse.data.trackingNumber);
    Console.WriteLine(apiResponse.data.courierCode);
}

Air Waybill

Create an air waybill.

https://api.trackingmore.com/v4/awb

AirWaybillParams airWaybillParams = new AirWaybillParams();
airWaybillParams.awbNumber = "235-69030430";
var apiResponse = trackingMore.AirWaybill.CreateAnAirWayBill(airWaybillParams);
Console.WriteLine(apiResponse.meta.code);
Console.WriteLine(apiResponse.data.awbNumber);
Console.WriteLine(apiResponse.data.flightInfoNew[0].flightNumber);
Console.WriteLine(apiResponse.data.flightInfo["TK0721"].departStation);

Response Code

Trackingmore uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a charge failed, etc.), and codes in the 5xx range indicate an TrackingMore's server error.

Http CODE	META CODE	TYPE	MESSAGE
200	200	Success	Request response is successful
400	400	BadRequest	Request type error. Please check the API documentation for the request type of this API.
400	4101	BadRequest	Tracking No. already exists.
400	4102	BadRequest	Tracking No. no exists. Please use 「Create a tracking」 API first to create shipment.
400	4103	BadRequest	You have exceeded the shipment quantity of API call. The maximum quantity is 40 shipments per call.
400	4110	BadRequest	The value of tracking_number is invalid.
400	4111	BadRequest	Tracking_number is required.
400	4112	BadRequest	Invalid Tracking ID.
400	4113	BadRequest	Retrack is not allowed. You can only retrack an expired tracking.
400	4120	BadRequest	The value of courier_code is invalid.
400	4121	BadRequest	Cannot detect courier.
400	4122	BadRequest	Missing or invalid value of the special required fields for this courier.
400	4130	BadRequest	The format of Field name is invalid.
400	4160	BadRequest	The awb_number is required or invaild format.
400	4161	BadRequest	The awb airline does not support yet.
400	4190	BadRequest	You are reaching the maximum quota limitation, please upgrade your current plan.
401	401	Unauthorized	Authentication failed or has no permission. Please check and ensure your API Key is correct.
403	403	Forbidden	Access prohibited. The request has been refused or access is not allowed.
404	404	NotFound	Page does not exist. Please check and ensure your link is correct.
429	429	TooManyRequests	Exceeded API request limits, please try again later. Please check the API documentation for the limit of this API.
500	511	ServerError	Server error. Please contact us: [email protected].
500	512	ServerError	Server error. Please contact us: [email protected].
500	513	ServerError	Server error. Please contact us: [email protected].