CarrierLib shipcloud Example

1
2
3
4
5
6
7
8
9
10

 
// Setup the main CarrierLib instance, get evaluation license key from Leisenfels website
CarrierLib carrierlib = new CarrierLib();
carrierlib.setLicenseFile(licensefile); // Import from file
 
// Setup shipcloud provider
String baseurl = ShipcloudProvider.SHIPCLOUD_SANDBOX_BASE_URI;
String version = ShipcloudProvider.SHIPCLOUD_API_V1;
ShipcloudProvider provider = carrierlib.createProviderShipcloud(baseurl, version, apikey);
 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

 
CarrierDefV1[] carriers = null;
try {
 Object obj = provider.requestCarriers(new Hashtable<String, Object>(0));
 
 if (obj instanceof CarrierDefV1[]) {
 carriers = (CarrierDefV1[]) obj;
 for (int i = 1; i <= carriers.length; i++) {
 System.out.println(" " + i + ": " + String.valueOf(carriers[i - 1]));
 }
 }
}
catch (Exception e) {
 e.printStackTrace();
}
 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

 
CarrierDefV1 targetcarrier = null;
double minvalue = Double.MAX_VALUE;
try {
 for (int i = 1; i <= carriers.length; i++) {
 CarrierDefV1 carrier = carriers[i - 1];
 
 // Setup the single carrier requests
 Hashtable<String, Object> params = new Hashtable<String, Object>(0);
 params.put("carrier", carrier.getName());
 params.put("service", "standard");
 params.put("to_street", "Beispielstrasse");
 params.put("to_street_no", "42");
 params.put("to_zip_code", "22100");
 params.put("to_city", "Hamburg");
 params.put("to_country", "DE");
 params.put("from_street", "Musterstrasse");
 params.put("from_street_no", "23");
 params.put("from_zip_code", "20148");
 params.put("from_city", "Hamburg");
 params.put("from_country", "DE");
 params.put("weight", 1.5); // kg
 params.put("length", 20); // cm
 params.put("width", 20); // cm
 params.put("height", 20); // cm
 
 Object obj = null;
 try {
 // Single carriers may not be supported here (exceptions)
 obj = provider.requestShipmentQuote(params);
 
 if (obj instanceof ShipmentQuoteDefV1) {
 ShipmentQuoteDefV1 quote = (ShipmentQuoteDefV1) obj;
 String formatted = format.format(quote.getCharge());
 System.out.println(" " + i + ": Charge for " + carrier + ": " + formatted + " EUR");
 if (quote.getCharge() < minvalue) targetcarrier = carrier;
 minvalue = Math.min(minvalue, quote.getCharge());
 continue;
 }
 }
 catch (Exception e) {
 // shipcloud sends HTTP status code 422 Unprocessable Entity
 // if a quote is not available for a certain carrier and package.
 //e.printStackTrace();
 //System.err.println("\n shipcloud responds: " + WebRequestException.getDebugInfo(e)); // Print some extra information
 }
 System.out.println(" " + i + ": Charge for " + String.valueOf(carrier) + ": (not available)");
 }
}
catch (Exception e) {
 e.printStackTrace(); 
}
 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

 
NewShipmentDefV1 newshipmentdef = null;
Hashtable<String, Object> createparams = null; // Reused for update
try {
 createparams = new Hashtable<String, Object>(0);
 createparams.put("to_company", "Receiver Inc.");
 createparams.put("to_first_name", "Max");
 createparams.put("to_last_name", "Mustermann");
 createparams.put("to_street", "Beispielstrasse");
 createparams.put("to_street_no", "42");
 createparams.put("to_city", "Hamburg");
 createparams.put("to_zip_code", "22100");
 createparams.put("to_country", "DE");
 createparams.put("weight", 1.5); // kg
 createparams.put("length", 20); // cm
 createparams.put("width", 20); // cm
 createparams.put("height", 20); // cm
 createparams.put("value", 123.45);
 createparams.put("currency", "EUR");
 createparams.put("carrier", targetcarrier.getName());
 createparams.put("service", "standard");
 createparams.put("reference_number", "ref123456");
 createparams.put("notification_email", "This email address is being protected from spambots. You need JavaScript enabled to view it.");
 createparams.put("create_shipping_label", false); // Not possible for sandbox system
 
 Object obj = provider.requestNewShipment(createparams);
 
 if (obj instanceof NewShipmentDefV1) newshipmentdef = (NewShipmentDefV1) obj;
}
catch (Exception e) {
 e.printStackTrace();
}
 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

 
ShipmentDefV1 shipment = null;
try {
 // We use the fixed version request method here to show how this can be done
 shipment = provider.requestShipmentDetailsV1(newshipmentdef.getId());
}
catch (Exception e) {
 e.printStackTrace();
 System.err.println("\n shipcloud responds: " + WebRequestException.getDebugInfo(e)); // Print some extra information
 }
 
if (shipment != null) {
 System.out.print(shipment.debugPrint(" "));
}
 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

 
ShipmentListDefV1 allshipments = null;
try {
 Hashtable<String, Object> params = new Hashtable<String, Object>(0);
 // Feel free to add filters here:
 //params.put("carrier", "dhl");
 //params.put("service", "standard");
 //params.put("reference_number", "ref123456");
 //params.put("carrier_tracking_no", "43128000105");
 //params.put("tracking_status", "out_for_delivery");
 //params.put("page", 1);
 //params.put("per_page", 25);
 Object obj = provider.requestAllShipments(params);
 
 if (obj instanceof ShipmentListDefV1) {
 allshipments = (ShipmentListDefV1) obj;
 }
}
catch (Exception e) {
 e.printStackTrace();
 System.err.println("\n shipcloud responds: " + WebRequestException.getDebugInfo(e)); // Print some extra information
}
 
if (allshipments != null) {
 System.out.println(" Found totally " + allshipments.getShipments().length + " shipment(s):");
 int count = allshipments.getShipments().length;
 for (int i = 0; i < count; i++) {
 System.out.println("\n Shipment " + (i + 1) + " of " + count + ':');
 System.out.print(allshipments.getShipments()[i].debugPrint(" "));
 }
}
 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

 
NewShipmentDefV1 updateddef = null;
ShipmentDefV1 updatedshipment = null;
try {
 // We can reuse the create params here, add second package for the shipment (package change is not possible)
 createparams.put("id", newshipmentdef.getId());
 createparams.put("weight", 3.0); // kg
 createparams.put("length", 40); // cm
 createparams.put("width", 40); // cm
 createparams.put("height", 40); // cm
 // Omit value here
 
 Object obj = provider.requestUpdateShipment(createparams);
 
 if (obj instanceof NewShipmentDefV1) {
 updateddef = (NewShipmentDefV1) obj;
 
 // Get shipment details again
 updatedshipment = provider.requestShipmentDetailsV1(newshipmentdef.getId());
 }
}
catch (Exception e) {
 e.printStackTrace();
 System.err.println("\n shipcloud responds: " + WebRequestException.getDebugInfo(e)); // Print some extra information
}
 
if (updateddef != null && updatedshipment != null) {
 System.out.println(" Successful!");
 System.out.println("\nReading the updated shipment details:");
 System.out.print(updatedshipment.debugPrint(" "));
}
 

1
2
3
4
5
6
7
8
9
10
11
12
13

 
boolean success = false;
try {
 Hashtable<String, Object> params = new Hashtable<String, Object>(0);
 params.put("id", newshipmentdef.getId());
 
 success = provider.requestDeleteShipment(params);
}
catch (Exception e) {
 e.printStackTrace();
 System.err.println("\n shipcloud responds: " + WebRequestException.getDebugInfo(e)); // Print some extra information
}