Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 78 additions & 78 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ If you need support using AfterShip products, please contact support@aftership.c
- [Error Handling](#error-handling)
- [Error List](#error-list)
- [Endpoints](#endpoints)
- [/trackings](#trackings)
- [/couriers](#couriers)
- [/courier-connections](#courier-connections)
- [/estimated-delivery-date](#estimated-delivery-date)
- [/trackings](#trackings)
- [Help](#help)
- [License](#license)

Expand All @@ -47,7 +47,7 @@ Before you begin to integrate:
<dependency>
<groupId>com.aftership</groupId>
<artifactId>tracking-sdk</artifactId>
<version>10.0.1</version>
<version>10.0.2</version>
</dependency>
```

Expand Down Expand Up @@ -144,6 +144,14 @@ The SDK will return an error object when there is any error during the request,

The AfterShip SDK has the following resource which are exactly the same as the API endpoints:

- TrackingResource
- Get trackings
- Create a tracking
- Get a tracking by ID
- Update a tracking by ID
- Delete a tracking by ID
- Retrack an expired tracking by ID
- Mark tracking as completed by ID
- CourierResource
- Get couriers
- Detect courier
Expand All @@ -156,177 +164,169 @@ The AfterShip SDK has the following resource which are exactly the same as the A
- EstimatedDeliveryDateResource
- Prediction for the Estimated Delivery Date
- Batch prediction for the Estimated Delivery Date
- TrackingResource
- Get trackings
- Create a tracking
- Get a tracking by ID
- Update a tracking by ID
- Delete a tracking by ID
- Retrack an expired tracking by ID
- Mark tracking as completed by ID

### /couriers
**GET** /couriers
### /trackings
**GET** /trackings

```java
GetCouriersResponse response = CourierResource.getCouriers()
GetTrackingsResponse response = TrackingResource.getTrackings()
.fetch();
System.out.println(response.getData());
```

**POST** /couriers/detect
**POST** /trackings

```java
DetectCourierRequest request = new DetectCourierRequest();
CreateTrackingRequest request = new CreateTrackingRequest();
request.setTrackingNumber("valid_value");
DetectCourierResponse response = CourierResource.detectCourier()
.setDetectCourierRequest(request)
CreateTrackingResponse response = TrackingResource.createTracking()
.setCreateTrackingRequest(request)
.create();
System.out.println(response.getData());
```

### /courier-connections
**GET** /courier-connections
**GET** /trackings/{id}

```java
GetCourierConnectionsResponse response = CourierConnectionResource.getCourierConnections()
GetTrackingByIdResponse response = TrackingResource.getTrackingById()
.setId("valid_value")
.fetch();
System.out.println(response.getData());
```

**POST** /courier-connections
**PUT** /trackings/{id}

```java
PostCourierConnectionsRequest request = new PostCourierConnectionsRequest();
request.setCourierSlug("valid_value");
request.setCredentials();
PostCourierConnectionsResponse response = CourierConnectionResource.postCourierConnections()
.setPostCourierConnectionsRequest(request)
.create();
UpdateTrackingByIdRequest request = new UpdateTrackingByIdRequest();
UpdateTrackingByIdResponse response = TrackingResource.updateTrackingById()
.setId("valid_value")
.setUpdateTrackingByIdRequest(request)
.update();
System.out.println(response.getData());
```

**GET** /courier-connections/{id}
**DELETE** /trackings/{id}

```java
GetCourierConnectionsByIdResponse response = CourierConnectionResource.getCourierConnectionsById()
DeleteTrackingByIdResponse response = TrackingResource.deleteTrackingById()
.setId("valid_value")
.fetch();
.delete();
System.out.println(response.getData());
```

**PATCH** /courier-connections/{id}
**POST** /trackings/{id}/retrack

```java
PutCourierConnectionsByIdRequest request = new PutCourierConnectionsByIdRequest();
request.setCredentials();
PutCourierConnectionsByIdResponse response = CourierConnectionResource.putCourierConnectionsById()
RetrackTrackingByIdResponse response = TrackingResource.retrackTrackingById()
.setId("valid_value")
.setPutCourierConnectionsByIdRequest(request)
.update();
.create();
System.out.println(response.getData());
```

**DELETE** /courier-connections/{id}
**POST** /trackings/{id}/mark-as-completed

```java
DeleteCourierConnectionsByIdResponse response = CourierConnectionResource.deleteCourierConnectionsById()
MarkTrackingCompletedByIdRequest request = new MarkTrackingCompletedByIdRequest();
MarkTrackingCompletedByIdResponse response = TrackingResource.markTrackingCompletedById()
.setId("valid_value")
.delete();
.setMarkTrackingCompletedByIdRequest(request)
.create();
System.out.println(response.getData());
```

### /estimated-delivery-date
**POST** /estimated-delivery-date/predict
### /couriers
**GET** /couriers

```java
EstimatedDeliveryDateRequest request = new EstimatedDeliveryDateRequest();
request.setSlug("valid_value");
EstimatedDeliveryDateRequestOriginAddress originAddress = new EstimatedDeliveryDateRequestOriginAddress();
request.setOriginAddress(originAddress);
EstimatedDeliveryDateRequestDestinationAddress destinationAddress = new EstimatedDeliveryDateRequestDestinationAddress();
request.setDestinationAddress(destinationAddress);
PredictResponse response = EstimatedDeliveryDateResource.predict()
.setPredictRequest(request)
.create();
GetCouriersResponse response = CourierResource.getCouriers()
.fetch();
System.out.println(response.getData());
```

**POST** /estimated-delivery-date/predict-batch
**POST** /couriers/detect

```java
PredictBatchRequest request = new PredictBatchRequest();
PredictBatchResponse response = EstimatedDeliveryDateResource.predictBatch()
.setPredictBatchRequest(request)
DetectCourierRequest request = new DetectCourierRequest();
request.setTrackingNumber("valid_value");
DetectCourierResponse response = CourierResource.detectCourier()
.setDetectCourierRequest(request)
.create();
System.out.println(response.getData());
```

### /trackings
**GET** /trackings
### /courier-connections
**GET** /courier-connections

```java
GetTrackingsResponse response = TrackingResource.getTrackings()
GetCourierConnectionsResponse response = CourierConnectionResource.getCourierConnections()
.fetch();
System.out.println(response.getData());
```

**POST** /trackings
**POST** /courier-connections

```java
CreateTrackingRequest request = new CreateTrackingRequest();
request.setTrackingNumber("valid_value");
CreateTrackingResponse response = TrackingResource.createTracking()
.setCreateTrackingRequest(request)
PostCourierConnectionsRequest request = new PostCourierConnectionsRequest();
request.setCourierSlug("valid_value");
request.setCredentials();
PostCourierConnectionsResponse response = CourierConnectionResource.postCourierConnections()
.setPostCourierConnectionsRequest(request)
.create();
System.out.println(response.getData());
```

**GET** /trackings/{id}
**GET** /courier-connections/{id}

```java
GetTrackingByIdResponse response = TrackingResource.getTrackingById()
GetCourierConnectionsByIdResponse response = CourierConnectionResource.getCourierConnectionsById()
.setId("valid_value")
.fetch();
System.out.println(response.getData());
```

**PUT** /trackings/{id}
**PATCH** /courier-connections/{id}

```java
UpdateTrackingByIdRequest request = new UpdateTrackingByIdRequest();
UpdateTrackingByIdResponse response = TrackingResource.updateTrackingById()
PutCourierConnectionsByIdRequest request = new PutCourierConnectionsByIdRequest();
request.setCredentials();
PutCourierConnectionsByIdResponse response = CourierConnectionResource.putCourierConnectionsById()
.setId("valid_value")
.setUpdateTrackingByIdRequest(request)
.setPutCourierConnectionsByIdRequest(request)
.update();
System.out.println(response.getData());
```

**DELETE** /trackings/{id}
**DELETE** /courier-connections/{id}

```java
DeleteTrackingByIdResponse response = TrackingResource.deleteTrackingById()
DeleteCourierConnectionsByIdResponse response = CourierConnectionResource.deleteCourierConnectionsById()
.setId("valid_value")
.delete();
System.out.println(response.getData());
```

**POST** /trackings/{id}/retrack
### /estimated-delivery-date
**POST** /estimated-delivery-date/predict

```java
RetrackTrackingByIdResponse response = TrackingResource.retrackTrackingById()
.setId("valid_value")
EstimatedDeliveryDateRequest request = new EstimatedDeliveryDateRequest();
request.setSlug("valid_value");
EstimatedDeliveryDateRequestOriginAddress originAddress = new EstimatedDeliveryDateRequestOriginAddress();
request.setOriginAddress(originAddress);
EstimatedDeliveryDateRequestDestinationAddress destinationAddress = new EstimatedDeliveryDateRequestDestinationAddress();
request.setDestinationAddress(destinationAddress);
PredictResponse response = EstimatedDeliveryDateResource.predict()
.setPredictRequest(request)
.create();
System.out.println(response.getData());
```

**POST** /trackings/{id}/mark-as-completed
**POST** /estimated-delivery-date/predict-batch

```java
MarkTrackingCompletedByIdRequest request = new MarkTrackingCompletedByIdRequest();
MarkTrackingCompletedByIdResponse response = TrackingResource.markTrackingCompletedById()
.setId("valid_value")
.setMarkTrackingCompletedByIdRequest(request)
PredictBatchRequest request = new PredictBatchRequest();
PredictBatchResponse response = EstimatedDeliveryDateResource.predictBatch()
.setPredictBatchRequest(request)
.create();
System.out.println(response.getData());
```
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>com.aftership</groupId>
<artifactId>tracking-sdk</artifactId>
<version>10.0.1</version>
<version>10.0.2</version>

<name>AfterShip Tracking SDK</name>
<description>The official AfterShip Tracking Java API library</description>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/aftership/tracking/http/HttpClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

public class HttpClient {

private static final String DEFAULT_USER_AGENT = "tracking-sdk-java/10.0.1 (https://www.aftership.com) apache-httpclient/4.5.14";
private static final String DEFAULT_USER_AGENT = "tracking-sdk-java/10.0.2 (https://www.aftership.com) apache-httpclient/4.5.14";
protected final org.apache.http.client.HttpClient client;

public HttpClient(final RequestConfig requestConfig, String userAgent) {
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/aftership/tracking/http/Request.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public void setDomain(final String domain) throws Exception {
URIBuilder validateURI = new URIBuilder(domain);
uriBuilder.setHost(validateURI.getHost());
uriBuilder.setScheme(validateURI.getScheme());
uriBuilder.setPort(validateURI.getPort());
}

public void setAuth(final String apiKey, final String apiSecret, final AuthType authenticationType) throws Exception {
Expand Down