Skip to content
BranchesTags

Repository files navigation

aftership-sdk-java

Maven CentralAfterShip SDKs channelBuild Status

The Java SDK of AfterShip API, please see API documentation in: https://www.aftership.com/docs/api/4

Requirements:

  • JDK 1.8 or superior.

Installation

Maven

<dependency>
<groupId>com.aftership</groupId>
<artifactId>aftership-sdk</artifactId>
<version>2.0.8</version>
</dependency>

Gradle

implementation "com.aftership:aftership-sdk:2.0.8"

Quick Examples

Main Steps

The following code example shows the three main steps to use aftership-sdk-java:

  1. Create AfterShip Object.
AfterShipafterShip = newAfterShip("YOUR_API_KEY", newAftershipOption("https://api.aftership.com/v4"));
  1. Get the Endpoint Interface and call the method, then return the object.
CourierList courierList = afterShip.getCourierEndpoint().listCouriers();
  1. Handling Data or AftershipException or RateLimit
try {
AfterShipafterShip =
newAfterShip("YOUR_API_KEY", newAftershipOption("https://api.aftership.com/v4"));
CourierListcourierList = afterShip.getCourierEndpoint().listCouriers();
// using dataSystem.out.println(courierList);
} catch (SdkException | RequestExceptione) {
// handle SdkException, RequestExceptionSystem.out.println(e.getType());
System.out.println(e.getMessage());
System.out.println(e.getData());
} catch (ApiExceptione) {
// handle ApiExceptionif (e.isTooManyRequests()) {
// Analyze RateLimit when TooManyRequests occurSystem.out.println(e.getRateLimit().getReset());
System.out.println(e.getRateLimit().getLimit());
System.out.println(e.getRateLimit().getRemaining());
return;
}
System.out.println(e.getType());
System.out.println(e.getCode());
System.out.println(e.getMessage());
}

Error Handling

There are 4 kinds of exception

  • AftershipException
  • SdkException
  • RequestException
  • ApiException

Error object of this SDK contain fields:

  • type - Require - type of the error, please handle each error by this field

  • message - Optional - detail message of the error

  • code - Optional - error code for API Error

    You can find tips for Aftership's error codes in here: https://docs.aftership.com/api/4/errors

    If it's Aftership's API Error, get code to confirm the cause of the error:

    catch (AftershipExceptione){
if(e.isApiError()){
System.out.println(e.getCode());
}
}

  • data - Optional - data lead to the error

    The debug Data is a Map<String, Object> object that can get the call parameters.

    The following data may be available:

    catch (AftershipException e){
System.out.println(e.getData());
// or
System.out.println(e.getData().get(DEBUG_DATA_KEY_REQUEST_CONFIG));
System.out.println(e.getData().get(DEBUG_DATA_KEY_REQUEST_HEADERS));
System.out.println(e.getData().get(DEBUG_DATA_KEY_REQUEST_DATA));
System.out.println(e.getData().get(DEBUG_DATA_KEY_RESPONSE_BODY));
}

AftershipException

AftershipException is the base class for all exception classes and can capture it for uniform handling.

See the Rate Limiter section for TooManyRequests in ApiException.

catch (AftershipExceptione){
if(e.isApiError()){
System.out.println(e.getCode());
if(e.isTooManyRequests() && einstanceofApiException){
System.out.println(((ApiException)e).getRateLimit());
}
}
System.out.println(e.getType());
System.out.println(e.getMessage());
System.out.println(e.getData());
}

SdkException

Exception return by the SDK instance, mostly invalid param type when calling constructor or endpoint method error.Type is one of ErrorTypeThrow by the SDK instance

try {
AfterShipafterShip =
newAfterShip(null, newAftershipOption("https://api.aftership.com/v4"));
} catch (SdkExceptione) {
System.out.println(e.getMessage());
}
/* ConstructorError: Invalid API key; type: ConstructorError */

Throw by endpoint method

try {
AfterShipafterShip =
newAfterShip("YOUR_API_KEY", newAftershipOption("https://api.aftership.com/v4"));
afterShip.getTrackingEndpoint().getTracking("", null);
} catch (SdkExceptione) {
System.out.println(e.getMessage());
}
/* ConstructorError: Required tracking id; type: ConstructorError */

RequestException

Error return by the request module error.Type could be HandlerError, etc.

try {
AfterShipafterShip =
newAfterShip("YOUR_API_KEY", newAftershipOption("https://api.aftership.com/v4"));
afterShip.getTrackingEndpoint().getTracking("abc", null);
} catch (RequestExceptione) {
System.out.println(e.getMessage());
}
/* null; type: HandlerError; */

ApiException

Error return by the AfterShip API
error.Type should be the same as https://www.aftership.com/docs/api/4/errors

try {
AfterShipafterShip =
newAfterShip("YOUR_API_KEY", newAftershipOption("https://api.aftership.com/v4"));
afterShip.getTrackingEndpoint().getTracking("abc", null);
} catch (ApiExceptione) {
System.out.println(e.getMessage());
}
/* The value of `id` is invalid.; type: BadRequest; code: 4015; */

Rate Limiter

To understand AfterShip rate limit policy, please see limit session in https://www.aftership.com/docs/api/4

You can get the recent rate limit by ApiException.getRateLimit().

try {
AfterShipafterShip =
newAfterShip("YOUR_API_KEY", newAftershipOption("https://api.aftership.com/v4"));
afterShip.getCourierEndpoint().listCouriers();
} catch (SdkException | RequestExceptione) {
System.out.println(e.getType());
} catch (ApiExceptione) {
if (e.isTooManyRequests()) {
System.out.println(e.getRateLimit().getReset());
System.out.println(e.getRateLimit().getLimit());
System.out.println(e.getRateLimit().getRemaining());
}
}
// 1589869159// 10// 9

Timeout

When creating an Aftership object, you can define the timeout time for http requests, Of course, use the default value of 20 seconds when not set. The unit is milliseconds.

AftershipOption option = new AftershipOption();
option.setEndpoint("https://api.aftership.com/v4");
option.setCallTimeout(10 * 1000);
option.setConnectTimeout(10 * 1000);
option.setReadTimeout(10 * 1000);
option.setWriteTimeout(10 * 1000);
AfterShip afterShip = new AfterShip(SampleUtil.getApiKey(), option);

Shutdown

We recommend using only one AfterShip object to request interfaces of the API, and calling the shutdown method if you want to completely clean up all network resources when you shut down your system. In other cases, not running shutdown method has no effect.

try {
afterShip.getCourierEndpoint().listCouriers();
} catch (RequestException | ApiExceptione) {
e.printStackTrace();
} finally {
try {
afterShip.shutdown();
} catch (IOExceptione) {
e.printStackTrace();
}
}

Examples

/couriers

  • listCouriers [GET /couriers]

try {
CourierList courierList = afterShip.getCourierEndpoint().listCouriers();
System.out.println(courierList.getTotal());
System.out.println(courierList.getCouriers().get(0).getName());
} catch (AftershipException e) {
System.out.println(e.getMessage());
}

  • listAllCouriers [GET /couriers/all]

try {
CourierList courierList = afterShip.getCourierEndpoint().listAllCouriers();
System.out.println(courierList.getTotal());
System.out.println(courierList.getCouriers());
} catch (AftershipException e) {
System.out.println(e.getMessage());
}

  • detectCouriers [POST /couriers/detect]

CourierDetectTrackingtracking = newCourierDetectTracking();
tracking.setTrackingNumber("906587618687");
CourierDetectRequestcourierDetectRequest = newCourierDetectRequest(tracking);
try {
CourierDetectListcourierDetectList =
afterShip.getCourierEndpoint().detectCouriers(courierDetectRequest.getTracking());
System.out.println(courierDetectList.getTotal());
System.out.println(courierDetectList.getCouriers());
} catch (AftershipExceptione) {
System.out.println(e.getMessage());
}

/trackings

  • createTracking [POST /trackings]

NewTrackingnewTracking = newNewTracking();
// slug from listAllCouriers()newTracking.setSlug(newString[] {"acommerce"});
newTracking.setTrackingNumber("1234567890");
newTracking.setTitle("Title Name");
newTracking.setSmses(newString[] {"+18555072509", "+18555072501"});
newTracking.setEmails(newString[] {"email@yourdomain.com", "another_email@yourdomain.com"});
newTracking.setOrderId("ID 1234");
newTracking.setOrderIdPath("http://www.aftership.com/order_id=1234");
newTracking.setCustomFields(
newHashMap<String, String>(2) {
{
put("product_name", "iPhone Case");
put("product_price", "USD19.99");
}
});
newTracking.setLanguage("en");
newTracking.setOrderPromisedDeliveryDate("2019-05-20");
newTracking.setDeliveryType("pickup_at_store");
newTracking.setPickupLocation("Flagship Store");
newTracking.setPickupNote(
"Reach out to our staffs when you arrive our stores for shipment pickup");
try {
Trackingtracking = afterShip.getTrackingEndpoint().createTracking(newTracking);
System.out.println(tracking);
} catch (AftershipExceptione) {
System.out.println(e.getMessage());
}

  • deleteTracking [DELETE /trackings/:slug/:tracking_number]

String id = "u2qm5uu9xqpwykaqm8d5l010";
try {
Tracking tracking = afterShip.getTrackingEndpoint().deleteTracking(id);
System.out.println(tracking);
} catch (AftershipException e) {
System.out.println(e.getMessage());
}

  • getTrackings [GET /trackings]

GetTrackingsParams optionalParams = new GetTrackingsParams();
optionalParams.setFields("title,order_id");
optionalParams.setLang("china-post");
optionalParams.setLimit(10);
try {
PagedTrackings pagedTrackings = afterShip.getTrackingEndpoint().getTrackings(optionalParams);
System.out.println(pagedTrackings);
} catch (AftershipException e) {
System.out.println(e.getMessage());
}

  • getTracking [GET /trackings/:slug/:tracking_number]

    • Get by id:

      Stringid = "l389dilsluk9ckaqmetr901y";
try {
Trackingtracking = afterShip.getTrackingEndpoint().getTracking(id, null);
System.out.println(tracking);
} catch (AftershipExceptione) {
System.out.println(e.getMessage());
}

    • Get by slug and tracking_number:

      String slug = "acommerce";
String trackingNumber = "1234567890";
try {
Tracking tracking =
afterShip
.getTrackingEndpoint()
.getTracking(new SlugTrackingNumber(slug, trackingNumber), null);
System.out.println(tracking);
} catch (AftershipException e) {
System.out.println(e.getMessage());
}

  • updateTracking [PUT /trackings/:slug/:tracking_number]

Stringid = "vebix4hfu3sr3kac0epve01n";
UpdateTrackingupdateTracking = newUpdateTracking();
updateTracking.setTitle("title123");
try {
Trackingtracking1 = afterShip.getTrackingEndpoint().updateTracking(id, updateTracking);
System.out.println(tracking1);
} catch (AftershipExceptione) {
System.out.println(e.getMessage());
}

  • reTrack [POST /trackings/:slug/:tracking_number/retrack]

Stringid = "l389dilsluk9ckaqmetr901y";
try {
Trackingtracking = afterShip.getTrackingEndpoint().reTrack(id);
System.out.println(tracking);
} catch (AftershipExceptione) {
System.out.println(e.getMessage());
}

  • markAsCompleted [POST /trackings/:slug/:tracking_number/mark-as-completed]

String id = "5b7658cec7c33c0e007de3c5";
try {
Tracking tracking =
afterShip.getTrackingEndpoint().markAsCompleted(id, new CompletedStatus(ReasonKind.LOST));
System.out.println(tracking);
} catch (AftershipException e) {
System.out.println(e.getMessage());
}

/last_checkpoint

  • getLastCheckpoint [GET /last_checkpoint/:slug/:tracking_number]

Stringid = "vebix4hfu3sr3kac0epve01n";
GetCheckpointParamoptionalParam = newGetCheckpointParam();
optionalParam.setFields(FieldsKind.combine(FieldsKind.TAG));
optionalParam.setLang(LangKind.CHINA_EMS);
try {
LastCheckpointlastCheckpoint =
afterShip.getCheckpointEndpoint().getLastCheckpoint(id, optionalParam);
System.out.println(lastCheckpoint.getSlug());
System.out.println(lastCheckpoint.getTrackingNumber());
System.out.println(lastCheckpoint.getCheckpoint());
} catch (AftershipExceptione) {
System.out.println(e.getMessage());
}

/notifications

  • getNotification [GET /notifications/:slug/:tracking_number]

String id = "vebix4hfu3sr3kac0epve01n";
try {
Notification notification = afterShip.getNotificationEndpoint().getNotification(id);
System.out.println(notification);
} catch (AftershipException e) {
System.out.println(e.getMessage());
}

  • addNotification [POST /notifications/:slug/:tracking_number/add]

Stringid = "vebix4hfu3sr3kac0epve01n";
NotificationaddNotification = newNotification();
addNotification.setSmses(newString[] {"+85261236123", "Invalid Mobile Phone Number"});
try {
Notificationnotification =
afterShip.getNotificationEndpoint().addNotification(id, addNotification);
System.out.println(notification);
} catch (AftershipExceptione) {
System.out.println(e.getMessage());
}

  • removeNotification [POST /notifications/:slug/:tracking_number/remove]

String id = "vebix4hfu3sr3kac0epve01n";
Notification removeNotification = new Notification();
removeNotification.setEmails(new String[] {"invalid EMail @ Gmail. com"});
removeNotification.setSmses(new String[] {"+85261236123"});
try {
Notification notification =
afterShip.getNotificationEndpoint().removeNotification(id, removeNotification);
System.out.println(notification);
} catch (AftershipException e) {
System.out.println(e.getMessage());
}

Notes

  • When specifying a tracking, the id is equivalent to the slug and tracking_number.

getTracking("l389dilsluk9ckaqmetr901y", null);

getTracking(new SlugTrackingNumber("acommerce", "1234567890"), null);

License

Copyright (c) 2015-2020 Aftership
Licensed under the MIT license.

​

About

The Java SDK of AfterShip API

Resources

Readme
MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages