Chilkat Online Tools

SQL Server / ShipEngine Walkthrough / Unsubscribe from tracking updates

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'API-Key', '{{API_KEY}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'POST', 'https://api.shipengine.com/v1/tracking/stop?carrier_code=stamps_com&tracking_number=1Z6Y21Y60300230257'
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http


END
GO

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