Java
Chilkat2 Java
Shippo Adding Metadata
See more Shippo Examples
Demonstrates how to add metadata to the tracking request through a POST request.Chilkat Java Downloads
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpRequest;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Http http = new Http();
// Implements the following CURL command:
// curl https://api.goshippo.com/tracks/ \
// -H "Authorization: ShippoToken <API_TOKEN>" \
// -d carrier="shippo" \
// -d tracking_number="SHIPPO_TRANSIT" \
// -d metadata="Order 000123"
HttpRequest req = new HttpRequest();
req.setHttpVerb("POST");
req.setPath("/tracks/");
req.setContentType("application/x-www-form-urlencoded");
req.addParam("carrier", "shippo");
req.addParam("tracking_number", "SHIPPO_TRANSIT");
req.addParam("metadata", "Order 000123");
req.addHeader("Authorization", "ShippoToken <API_TOKEN>");
HttpResponse resp = new HttpResponse();
try {
http.httpReq("https://api.goshippo.com/tracks/", req, resp);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
StringBuilder sbResponseBody = new StringBuilder();
resp.getBodySb(sbResponseBody);
JsonObject jResp = new JsonObject();
jResp.loadSb(sbResponseBody);
jResp.setEmitCompact(false);
System.out.println("Response Body:");
System.out.println(jResp.emit());
int respStatusCode = resp.getStatusCode();
System.out.println("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
System.out.println("Response Header:");
System.out.println(resp.getHeader());
System.out.println("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "messages": [
// ],
// "carrier": "shippo",
// "tracking_number": "SHIPPO_TRANSIT",
// "address_from": {
// "city": "San Francisco",
// "state": "CA",
// "zip": "94103",
// "country": "US"
// },
// "address_to": {
// "city": "Chicago",
// "state": "IL",
// "zip": "60611",
// "country": "US"
// },
// "eta": "2019-07-07T17:07:44.989Z",
// "original_eta": "2019-07-07T17:07:44.989Z",
// "servicelevel": {
// "token": "shippo_priority",
// "name": "Priority Mail"
// },
// "metadata": "Shippo test tracking",
// "tracking_status": {
// "object_created": "2019-07-04T17:07:45.003Z",
// "object_updated": null,
// "object_id": "ee35fb56f5d04021b36168abedc04573",
// "status": "TRANSIT",
// "status_details": "Your shipment has departed from the origin.",
// "status_date": "2019-07-03T15:02:45.003Z",
// "substatus": null,
// "location": {
// "city": "San Francisco",
// "state": "CA",
// "zip": "94103",
// "country": "US"
// }
// },
// "tracking_history": [
// {
// "object_created": "2019-07-04T17:07:45.005Z",
// "object_updated": null,
// "object_id": "2121a59f53ed42e0ae0436f636179156",
// "status": "UNKNOWN",
// "status_details": "The carrier has received the electronic shipment information.",
// "status_date": "2019-07-02T12:57:45.005Z",
// "substatus": null,
// "location": {
// "city": "San Francisco",
// "state": "CA",
// "zip": "94103",
// "country": "US"
// }
// },
// {
// "object_created": "2019-07-04T17:07:45.005Z",
// "object_updated": null,
// "object_id": "06f949db1a8245beaa28df264b368a76",
// "status": "TRANSIT",
// "status_details": "Your shipment has departed from the origin.",
// "status_date": "2019-07-03T15:02:45.005Z",
// "substatus": null,
// "location": {
// "city": "San Francisco",
// "state": "CA",
// "zip": "94103",
// "country": "US"
// }
// }
// ],
// "transaction": null,
// "test": true
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
String object_created = "";
String object_updated = "";
String object_id = "";
String status = "";
String status_details = "";
String status_date = "";
String substatus = "";
String locationCity = "";
String locationState = "";
String locationZip = "";
String locationCountry = "";
String carrier = jResp.stringOf("carrier");
String tracking_number = jResp.stringOf("tracking_number");
String address_fromCity = jResp.stringOf("address_from.city");
String address_fromState = jResp.stringOf("address_from.state");
String address_fromZip = jResp.stringOf("address_from.zip");
String address_fromCountry = jResp.stringOf("address_from.country");
String address_toCity = jResp.stringOf("address_to.city");
String address_toState = jResp.stringOf("address_to.state");
String address_toZip = jResp.stringOf("address_to.zip");
String address_toCountry = jResp.stringOf("address_to.country");
String eta = jResp.stringOf("eta");
String original_eta = jResp.stringOf("original_eta");
String servicelevelToken = jResp.stringOf("servicelevel.token");
String servicelevelName = jResp.stringOf("servicelevel.name");
String metadata = jResp.stringOf("metadata");
String tracking_statusObject_created = jResp.stringOf("tracking_status.object_created");
String tracking_statusObject_updated = jResp.stringOf("tracking_status.object_updated");
String tracking_statusObject_id = jResp.stringOf("tracking_status.object_id");
String tracking_statusStatus = jResp.stringOf("tracking_status.status");
String tracking_statusStatus_details = jResp.stringOf("tracking_status.status_details");
String tracking_statusStatus_date = jResp.stringOf("tracking_status.status_date");
String tracking_statusSubstatus = jResp.stringOf("tracking_status.substatus");
String tracking_statusLocationCity = jResp.stringOf("tracking_status.location.city");
String tracking_statusLocationState = jResp.stringOf("tracking_status.location.state");
String tracking_statusLocationZip = jResp.stringOf("tracking_status.location.zip");
String tracking_statusLocationCountry = jResp.stringOf("tracking_status.location.country");
String transaction = jResp.stringOf("transaction");
boolean test = jResp.boolOf("test");
int i = 0;
int count_i = jResp.sizeOfArray("messages");
while (i < count_i) {
jResp.setI(i);
i = i + 1;
}
i = 0;
count_i = jResp.sizeOfArray("tracking_history");
while (i < count_i) {
jResp.setI(i);
object_created = jResp.stringOf("tracking_history[i].object_created");
object_updated = jResp.stringOf("tracking_history[i].object_updated");
object_id = jResp.stringOf("tracking_history[i].object_id");
status = jResp.stringOf("tracking_history[i].status");
status_details = jResp.stringOf("tracking_history[i].status_details");
status_date = jResp.stringOf("tracking_history[i].status_date");
substatus = jResp.stringOf("tracking_history[i].substatus");
locationCity = jResp.stringOf("tracking_history[i].location.city");
locationState = jResp.stringOf("tracking_history[i].location.state");
locationZip = jResp.stringOf("tracking_history[i].location.zip");
locationCountry = jResp.stringOf("tracking_history[i].location.country");
i = i + 1;
}
}
}