PowerShell

Shippo POST to Transaction Endpoint

See more Shippo Examples

Demonstrates how to POST to the Transaction endpoint with your Rate object_id to purchase your international shipping label. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$http = New-Object Chilkat.Http

# Implements the following CURL command:

# curl https://api.goshippo.com/transactions \
#     -H "Authorization: ShippoToken <API_TOKEN>" \
#     -d rate="ec6143e746094bcab1bdc4c17600dabf"
#     -d label_file_type="PDF"
#     -d async=false

$req = New-Object Chilkat.HttpRequest
$req.HttpVerb = "POST"
$req.Path = "/transactions"
$req.ContentType = "application/x-www-form-urlencoded"
$req.AddParam("rate","ec6143e746094bcab1bdc4c17600dabf")
$req.AddParam("label_file_type","PDF")
$req.AddParam("async","false")

$req.AddHeader("Authorization","ShippoToken <API_TOKEN>")

$resp = New-Object Chilkat.HttpResponse
$success = $http.HttpReq("https://api.goshippo.com/transactions",$req,$resp)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")
    exit
}

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

# {
#   "object_state": "VALID",
#   "status": "SUCCESS",
#   "object_created": "2013-12-27T19:14:48.273Z",
#   "object_updated": "2013-12-27T19:14:48.273Z",
#   "object_id": "64bba01845ef40d29374032599f22588",
#   "object_owner": "shippotle@goshippo.com",
#   "was_test": false,
#   "rate": {
#     "object_id": "cf6fea899f1848b494d9568e8266e076",
#     "amount": "5.50",
#     "currency": "USD",
#     "amount_local": "5.50",
#     "currency_local": "USD",
#     "provider": "USPS",
#     "servicelevel_name": "Priority Mail",
#     "servicelevel_token": "usps_priority",
#     "carrier_account": "078870331023437cb917f5187429b093"
#   },
#   "tracking_number": "ZW70QJC",
#   "tracking_status": {
#     "object_created": "2013-12-27T23:17:41.411Z",
#     "object_id": "a21b3d6831c14ceaba6730179ce6e784",
#     "status": "UNKNOWN",
#     "status_details": "",
#     "status_date": "2013-12-28T12:04:04.214Z"
#   },
#   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=ZW70QJC",
#   "eta": "2013-12-30T12:00:00.000Z",
#   "label_url": "https://shippo-delivery.s3.amazonaws.com/96.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
#   "commercial_invoice_url": "",
#   "metadata": "",
#   "messages": [
#   ]
# }

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

$object_state = $jResp.StringOf("object_state")
$status = $jResp.StringOf("status")
$object_created = $jResp.StringOf("object_created")
$object_updated = $jResp.StringOf("object_updated")
$object_id = $jResp.StringOf("object_id")
$object_owner = $jResp.StringOf("object_owner")
$was_test = $jResp.BoolOf("was_test")
$rateObject_id = $jResp.StringOf("rate.object_id")
$rateAmount = $jResp.StringOf("rate.amount")
$rateCurrency = $jResp.StringOf("rate.currency")
$rateAmount_local = $jResp.StringOf("rate.amount_local")
$rateCurrency_local = $jResp.StringOf("rate.currency_local")
$rateProvider = $jResp.StringOf("rate.provider")
$rateServicelevel_name = $jResp.StringOf("rate.servicelevel_name")
$rateServicelevel_token = $jResp.StringOf("rate.servicelevel_token")
$rateCarrier_account = $jResp.StringOf("rate.carrier_account")
$tracking_number = $jResp.StringOf("tracking_number")
$tracking_statusObject_created = $jResp.StringOf("tracking_status.object_created")
$tracking_statusObject_id = $jResp.StringOf("tracking_status.object_id")
$tracking_statusStatus = $jResp.StringOf("tracking_status.status")
$tracking_statusStatus_details = $jResp.StringOf("tracking_status.status_details")
$tracking_statusStatus_date = $jResp.StringOf("tracking_status.status_date")
$tracking_url_provider = $jResp.StringOf("tracking_url_provider")
$eta = $jResp.StringOf("eta")
$label_url = $jResp.StringOf("label_url")
$commercial_invoice_url = $jResp.StringOf("commercial_invoice_url")
$metadata = $jResp.StringOf("metadata")
$i = 0
$count_i = $jResp.SizeOfArray("messages")
while ($i -lt $count_i) {
    $jResp.I = $i
    $i = $i + 1
}