Chilkat Online Tools

delphiDll / ShipEngine Walkthrough / Void a label

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
approved: Boolean;
message: PWideChar;

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

http := CkHttp_Create();

CkHttp_SetRequestHeader(http,'API-Key','{{API_KEY}}');

resp := CkHttp_QuickRequest(http,'PUT','https://api.shipengine.com/v1/labels/se-123456/void');
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "approved": true,
//   "message": "Request for refund submitted.  This label has been voided."
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

approved := CkJsonObject_BoolOf(jResp,'approved');
message := CkJsonObject__stringOf(jResp,'message');

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -X PUT
	-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/labels/se-123456/void

Postman Collection Item JSON

{
  "name": "Void a label",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "PUT",
    "header": [
    ],
    "url": {
      "raw": "https://api.shipengine.com/v1/labels/{{label_id}}/void",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "labels",
        "{{label_id}}",
        "void"
      ]
    },
    "description": "Some carriers (like USPS) charge for labels even if the package is never actually mailed. So if you decide not to ship a package, then you'll need to void the label to get your money back.  This request shows you how."
  },
  "response": [
    {
      "name": "Void a label",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "url": {
          "raw": "https://api.shipengine.com/v1/labels/{{label_id}}/void",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "labels",
            "{{label_id}}",
            "void"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 17 Sep 2019 21:28:48 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "100"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "server",
          "value": "Microsoft-IIS/8.0"
        },
        {
          "key": "x-newrelic-app-data",
          "value": "PxQGVFZXCgITVVZbAwMCV1YGFB9AMQYAZBBZDEtZV0ZaCldOeA9FBwpCWBMfTG1dUwsMD15FFzUQXlVYQEpTTABOCUwBDQEKClMKWR1MAk5GAnNTVVp7dXYhIyN1AgElVxMaVQMKEAdt"
        },
        {
          "key": "x-powered-by",
          "value": "ASP.NET"
        },
        {
          "key": "x-shipengine-environment",
          "value": "j"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "e0338fc7-f030-44ed-8cfe-4dcb877e24e0"
        },
        {
          "key": "x-shipengine-server",
          "value": "SS-J-WEB01"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"approved\": true,\n    \"message\": \"Request for refund submitted.  This label has been voided.\"\n}"
    }
  ]
}