TrackingApi.md

Tracking Methods

Method	Description
GetTrackingLog	Get Tracking Information
StartTracking	Start Tracking a Package
StopTracking	Stop Tracking a Package

GetTrackingLog

GetTrackingLogResponseBody GetTrackingLog (string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default)

GetTrackingLogResponseBody GetTrackingLog (HttpClient methodClient, string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default)

Get Tracking Information

Retrieve package tracking information

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class GetTrackingLogExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var carrierCode = stamps_com;
            var trackingNumber = 9405511899223197428490;

            try
            {
                // Get Tracking Information
                GetTrackingLogResponseBody result = await shipEngine.GetTrackingLog(carrierCode, trackingNumber);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling TrackingApi.GetTrackingLog: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
methodClient	HttpClient	The HttpClient instance to use for the request.
carrierCode	string	A shipping carrier, such as `fedex`, `dhl_express`, `stamps_com`, etc.	[optional]
trackingNumber	string	The tracking number associated with a shipment	[optional]
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

GetTrackingLogResponseBody

StartTracking

string StartTracking (string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default)

string StartTracking (HttpClient methodClient, string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default)

Start Tracking a Package

Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes.

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class StartTrackingExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var carrierCode = stamps_com;
            var trackingNumber = 9405511899223197428490;

            try
            {
                // Start Tracking a Package
                string result = await shipEngine.StartTracking(carrierCode, trackingNumber);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling TrackingApi.StartTracking: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
methodClient	HttpClient	The HttpClient instance to use for the request.
carrierCode	string	A shipping carrier, such as `fedex`, `dhl_express`, `stamps_com`, etc.	[optional]
trackingNumber	string	The tracking number associated with a shipment	[optional]
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

string

StopTracking

string StopTracking (string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default)

string StopTracking (HttpClient methodClient, string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default)

Stop Tracking a Package

Unsubscribe from tracking updates for a package.

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class StopTrackingExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var carrierCode = stamps_com;
            var trackingNumber = 9405511899223197428490;

            try
            {
                // Stop Tracking a Package
                string result = await shipEngine.StopTracking(carrierCode, trackingNumber);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling TrackingApi.StopTracking: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
methodClient	HttpClient	The HttpClient instance to use for the request.
carrierCode	string	A shipping carrier, such as `fedex`, `dhl_express`, `stamps_com`, etc.	[optional]
trackingNumber	string	The tracking number associated with a shipment	[optional]
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

string