Skip to content

Releases: AfterShip/tracking-sdk-net

14.0.0

21 Oct 06:59
e04064b

Choose a tag to compare

Breaking Changes - AfterShip Tracking .NET SDK v14.0.0

1. Response Structure Complete Refactor

Major Change: All response classes now have a wrapper structure with ResponseHeader and Data properties instead of directly containing response data.

// v13 - Direct access to response properties
var response = client.Tracking.CreateTracking(request);
string id = response.Id;
string trackingNumber = response.TrackingNumber;

// v14 - Must access through Data property
var response = client.Tracking.CreateTracking(request);
string id = response.Data.Id;
string trackingNumber = response.Data.TrackingNumber;
var headers = response.ResponseHeader; // New: Access to HTTP response headers

Applies to all API responses: CreateTracking, GetTrackingById, GetTrackings, UpdateTrackingById, GetCouriers, etc.

2. Model Name Changes - Prefix Naming Convention

Most nested model classes changed from suffix naming to prefix naming:

// v13 - Suffix naming
CourierEstimatedDeliveryDateTracking
ShipmentWeightTracking  
AftershipEstimatedDeliveryDateTracking
CarbonEmissionsTracking
CustomEstimatedDeliveryDateTracking
FirstEstimatedDeliveryTracking
LatestEstimatedDeliveryTracking
FirstMileTracking
LastMileTracking
CustomersTracking

// v14 - Prefix naming
TrackingCourierEstimatedDeliveryDate
TrackingShipmentWeight
TrackingAftershipEstimatedDeliveryDate
TrackingCarbonEmissions  
TrackingCustomEstimatedDeliveryDate
TrackingFirstEstimatedDelivery
TrackingLatestEstimatedDelivery
TrackingFirstMile
TrackingLastMile
TrackingCustomers

3. Enum Member Name Changes

Tag enum member names changed to PascalCase:

v13 v14
Tag.Inforeceived Tag.InfoReceived
Tag.Intransit Tag.InTransit
Tag.Outfordelivery Tag.OutForDelivery
Tag.Attemptfail Tag.AttemptFail
Tag.Availableforpickup Tag.AvailableForPickup

4. String to Enum Changes

Several string fields have been changed to enums (following API documentation):

Request Models (Input)

// 1. CreateTrackingRequest.DeliveryType
// v13
var request = new CreateTrackingRequest();
request.DeliveryType = "pickup_at_store";
// v14
var request = new CreateTrackingRequest();
request.DeliveryType = CreateTrackingRequestDeliveryType.PickupAtStore;

// 2. UpdateTrackingByIdRequest.DeliveryType
// v13
updateRequest.DeliveryType = "door_to_door";
// v14
updateRequest.DeliveryType = UpdateTrackingByIdRequestDeliveryType.DoorToDoor;

// 3. MarkTrackingCompletedByIdRequest.Reason
// v13
markRequest.Reason = "DELIVERED";
// v14
markRequest.Reason = MarkTrackingCompletedByIdRequestReason.Delivered;

Response Models (Output)

// 4. Tracking.SignatureRequirement
// v13
string signature = tracking.SignatureRequirement;
// v14
TrackingSignatureRequirement? signature = tracking.SignatureRequirement;

13.0.0

22 Sep 09:52
e04064b

Choose a tag to compare

What's Changed

Full Changelog: 12.0.0...13.0.0

12.0.0

22 Jul 08:20
0269384

Choose a tag to compare

What's Changed

Full Changelog: 11.0.0...12.0.0

11.0.0

23 Apr 06:15
153b61a

Choose a tag to compare

What's Changed

Full Changelog: 10.0.0...11.0.0

10.0.0

17 Jan 09:05
72bceb2

Choose a tag to compare

What's Changed

New Contributors

Full Changelog: https://github.com/AfterShip/tracking-sdk-net/commits/10.0.0

9.0.0

25 Oct 03:19
d5a0671

Choose a tag to compare

  • supporting 2024-10 version.

API and SDK Version

Each SDK version is designed to work with a specific API version. Please refer to the table below to identify the supported API versions for each SDK version, ensuring you select the appropriate SDK version for the API version you intend to use.

SDK Version Supported API Version Branch
9.x.x 2024-10 https://github.com/AfterShip/tracking-sdk-net/tree/2024-10
8.x.x 2024-07 https://github.com/AfterShip/tracking-sdk-net/tree/2024-07
7.x.x 2024-04 https://github.com/AfterShip/tracking-sdk-net/tree/2024-04
<=6.x.x Legacy API https://github.com/AfterShip/aftership-sdk-net

8.0.0

22 Aug 06:18
af9a26c

Choose a tag to compare

What's Changed

  • feat: supporting 2024-07 version. by @panxl6 in #3
  • misc: changed build directory. by @panxl6 in #4

Full Changelog: 7.0.1...8.0.0

7.0.1

20 Aug 02:14
f9841ad

Choose a tag to compare

What's Changed

  • feat: supporting 2024-04 version. by @panxl6 in #1
  • doc: fixed error in example. by @panxl6 in #2

New Contributors

  • @panxl6 made their first contribution in #1

Full Changelog: https://github.com/AfterShip/tracking-sdk-net/commits/7.0.1