(C#) Shippo Adding Metadata

Demonstrates how to add metadata to the tracking request through a POST request.

For more information, see https://goshippo.com/docs/tracking/

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

// 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"

Chilkat.HttpRequest req = new Chilkat.HttpRequest();
req.HttpVerb = "POST";
req.Path = "/tracks/";
req.ContentType = "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>");

Chilkat.HttpResponse resp = http.PostUrlEncoded("https://api.goshippo.com/tracks/",req);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("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");
bool test = jResp.BoolOf("test");
int i = 0;
int count_i = jResp.SizeOfArray("messages");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("tracking_history");
while (i < count_i) {
    jResp.I = 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;
}