Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")
http.SetRequestHeader "API-Key","{{API_KEY}}"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequest("PUT","https://api.shipengine.com/v1/labels/se-123456/void")
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = Server.CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = Server.CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"
respStatusCode = resp.StatusCode
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.Header) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"
Response.End
End If
' 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 = jResp.BoolOf("approved")
message = jResp.StringOf("message")
%>
</body>
</html>
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}"
}
]
}
