Chilkat Online Tools

Objective-C / ShipEngine Walkthrough / Unsubscribe from tracking updates

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

[http SetRequestHeader: @"API-Key" value: @"{{API_KEY}}"];

CkoHttpResponse *resp = [http QuickRequest: @"POST" url: @"https://api.shipengine.com/v1/tracking/stop?carrier_code=stamps_com&tracking_number=1Z6Y21Y60300230257"];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/tracking/stop?carrier_code=stamps_com&tracking_number=1Z6Y21Y60300230257

Postman Collection Item JSON

{
  "name": "Unsubscribe from tracking updates",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "url": {
      "raw": "https://api.shipengine.com/v1/tracking/stop?carrier_code=stamps_com&tracking_number={{tracking_number}}",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "tracking",
        "stop"
      ],
      "query": [
        {
          "key": "carrier_code",
          "value": "stamps_com"
        },
        {
          "key": "tracking_number",
          "value": "{{tracking_number}}"
        }
      ]
    },
    "description": "This request shows how to stop receiving tracking updates for a package.\n\n> **Note:** ShipEngine automatically unsubscribes from tracking updates once a package is delivered, or when a delivery exception occurs. So you don't need to explicitly unsubscribe in these cases."
  },
  "response": [
  ]
}