Chilkat Online Tools

Foxpro / ShipEngine Walkthrough / Void a label

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnApproved
LOCAL lcMessage

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

loHttp.SetRequestHeader("API-Key","{{API_KEY}}")

loResp = loHttp.QuickRequest("PUT","https://api.shipengine.com/v1/labels/se-123456/void")
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    CANCEL
ENDIF

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lnApproved = loJResp.BoolOf("approved")
lcMessage = loJResp.StringOf("message")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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}"
    }
  ]
}