(PowerShell) Shippo Create a Batch

Demonstrates how to create and purchase up to 10,000 shipments in a single API request.

For more information, see https://goshippo.com/docs/batch/

Chilkat .NET Downloads Chilkat .NET Assemblies

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

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

$http = New-Object Chilkat.Http

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "default_carrier_account": "078870331023437cb917f5187429b093",
#   "default_servicelevel_token": "usps_priority",
#   "label_filetype": "PDF_4x6",
#   "metadata": "BATCH #170",
#   "batch_shipments": [
#     {
#       "shipment": {
#         "address_from": {
#           "name": "Mr Hippo",
#           "street1": "965 Mission St",
#           "street2": "Ste 201",
#           "city": "San Francisco",
#           "state": "CA",
#           "zip": "94103",
#           "country": "US",
#           "phone": "4151234567",
#           "email": "mrhippo@goshippo.com"
#         },
#         "address_to": {
#           "name": "Mrs Hippo",
#           "company": "",
#           "street1": "Broadway 1",
#           "street2": "",
#           "city": "New York",
#           "state": "NY",
#           "zip": "10007",
#           "country": "US",
#           "phone": "4151234567",
#           "email": "mrshippo@goshippo.com"
#         },
#         "parcels": [
#           {
#             "length": "5",
#             "width": "5",
#             "height": "5",
#             "distance_unit": "in",
#             "weight": "2",
#             "mass_unit": "oz"
#           }
#         ]
#       }
#     },
#     {
#       "shipment": {
#         "address_from": {
#           "name": "Mr Hippo",
#           "street1": "1092 Indian Summer Ct",
#           "city": "San Jose",
#           "state": "CA",
#           "zip": "95122",
#           "country": "US",
#           "phone": "4151234567",
#           "email": "mrhippo@goshippo.com"
#         },
#         "address_to": {
#           "name": "Mrs Hippo",
#           "company": "",
#           "street1": "Broadway 1",
#           "street2": "",
#           "city": "New York",
#           "state": "NY",
#           "zip": "10007",
#           "country": "US",
#           "phone": "4151234567",
#           "email": "mrshippo@goshippo.com"
#         },
#         "parcels": [
#           {
#             "length": "5",
#             "width": "5",
#             "height": "5",
#             "distance_unit": "in",
#             "weight": "20",
#             "mass_unit": "lb"
#           }
#         ]
#       },
#       "carrier_account": "a4391cd4ab974f478f55dc08b5c8e3b3",
#       "servicelevel_token": "fedex_2_day"
#     }
#   ]
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("default_carrier_account","078870331023437cb917f5187429b093")
$json.UpdateString("default_servicelevel_token","usps_priority")
$json.UpdateString("label_filetype","PDF_4x6")
$json.UpdateString("metadata","BATCH #170")
$json.UpdateString("batch_shipments[0].shipment.address_from.name","Mr Hippo")
$json.UpdateString("batch_shipments[0].shipment.address_from.street1","965 Mission St")
$json.UpdateString("batch_shipments[0].shipment.address_from.street2","Ste 201")
$json.UpdateString("batch_shipments[0].shipment.address_from.city","San Francisco")
$json.UpdateString("batch_shipments[0].shipment.address_from.state","CA")
$json.UpdateString("batch_shipments[0].shipment.address_from.zip","94103")
$json.UpdateString("batch_shipments[0].shipment.address_from.country","US")
$json.UpdateString("batch_shipments[0].shipment.address_from.phone","4151234567")
$json.UpdateString("batch_shipments[0].shipment.address_from.email","mrhippo@goshippo.com")
$json.UpdateString("batch_shipments[0].shipment.address_to.name","Mrs Hippo")
$json.UpdateString("batch_shipments[0].shipment.address_to.company","")
$json.UpdateString("batch_shipments[0].shipment.address_to.street1","Broadway 1")
$json.UpdateString("batch_shipments[0].shipment.address_to.street2","")
$json.UpdateString("batch_shipments[0].shipment.address_to.city","New York")
$json.UpdateString("batch_shipments[0].shipment.address_to.state","NY")
$json.UpdateString("batch_shipments[0].shipment.address_to.zip","10007")
$json.UpdateString("batch_shipments[0].shipment.address_to.country","US")
$json.UpdateString("batch_shipments[0].shipment.address_to.phone","4151234567")
$json.UpdateString("batch_shipments[0].shipment.address_to.email","mrshippo@goshippo.com")
$json.UpdateString("batch_shipments[0].shipment.parcels[0].length","5")
$json.UpdateString("batch_shipments[0].shipment.parcels[0].width","5")
$json.UpdateString("batch_shipments[0].shipment.parcels[0].height","5")
$json.UpdateString("batch_shipments[0].shipment.parcels[0].distance_unit","in")
$json.UpdateString("batch_shipments[0].shipment.parcels[0].weight","2")
$json.UpdateString("batch_shipments[0].shipment.parcels[0].mass_unit","oz")
$json.UpdateString("batch_shipments[1].shipment.address_from.name","Mr Hippo")
$json.UpdateString("batch_shipments[1].shipment.address_from.street1","1092 Indian Summer Ct")
$json.UpdateString("batch_shipments[1].shipment.address_from.city","San Jose")
$json.UpdateString("batch_shipments[1].shipment.address_from.state","CA")
$json.UpdateString("batch_shipments[1].shipment.address_from.zip","95122")
$json.UpdateString("batch_shipments[1].shipment.address_from.country","US")
$json.UpdateString("batch_shipments[1].shipment.address_from.phone","4151234567")
$json.UpdateString("batch_shipments[1].shipment.address_from.email","mrhippo@goshippo.com")
$json.UpdateString("batch_shipments[1].shipment.address_to.name","Mrs Hippo")
$json.UpdateString("batch_shipments[1].shipment.address_to.company","")
$json.UpdateString("batch_shipments[1].shipment.address_to.street1","Broadway 1")
$json.UpdateString("batch_shipments[1].shipment.address_to.street2","")
$json.UpdateString("batch_shipments[1].shipment.address_to.city","New York")
$json.UpdateString("batch_shipments[1].shipment.address_to.state","NY")
$json.UpdateString("batch_shipments[1].shipment.address_to.zip","10007")
$json.UpdateString("batch_shipments[1].shipment.address_to.country","US")
$json.UpdateString("batch_shipments[1].shipment.address_to.phone","4151234567")
$json.UpdateString("batch_shipments[1].shipment.address_to.email","mrshippo@goshippo.com")
$json.UpdateString("batch_shipments[1].shipment.parcels[0].length","5")
$json.UpdateString("batch_shipments[1].shipment.parcels[0].width","5")
$json.UpdateString("batch_shipments[1].shipment.parcels[0].height","5")
$json.UpdateString("batch_shipments[1].shipment.parcels[0].distance_unit","in")
$json.UpdateString("batch_shipments[1].shipment.parcels[0].weight","20")
$json.UpdateString("batch_shipments[1].shipment.parcels[0].mass_unit","lb")
$json.UpdateString("batch_shipments[1].carrier_account","a4391cd4ab974f478f55dc08b5c8e3b3")
$json.UpdateString("batch_shipments[1].servicelevel_token","fedex_2_day")

$http.SetRequestHeader("Authorization","ShippoToken shippo_test_3af5d574e2f845d30efcaf9b2f47d9c2aef4807a")
$http.SetRequestHeader("Content-Type","application/json")

$resp = $http.PostJson3("https://api.goshippo.com/batches/","application/json",$json)
if ($http.LastMethodSuccess -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_id": "a015eb693cca465dbb6523ce6d2e3c65",
#   "object_owner": "admin",
#   "status": "VALIDATING",
#   "object_created": "2016-09-12T15:25:43.465Z",
#   "object_updated": "2016-09-12T15:25:43.465Z",
#   "metadata": "BATCH #170",
#   "default_carrier_account": "078870331023437cb917f5187429b093",
#   "default_servicelevel_token": "usps_priority",
#   "label_filetype": "PDF_4x6",
#   "batch_shipments": {
#     "next": null,
#     "previous": null,
#     "results": [
#     ]
#   },
#   "object_results": {
#     "purchase_succeeded": 0,
#     "purchase_failed": 0,
#     "creation_failed": 0,
#     "creation_succeeded": 0
#   },
#   "label_url": [
#   ]
# }

# 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_id = $jResp.StringOf("object_id")
$object_owner = $jResp.StringOf("object_owner")
$status = $jResp.StringOf("status")
$object_created = $jResp.StringOf("object_created")
$object_updated = $jResp.StringOf("object_updated")
$metadata = $jResp.StringOf("metadata")
$default_carrier_account = $jResp.StringOf("default_carrier_account")
$default_servicelevel_token = $jResp.StringOf("default_servicelevel_token")
$label_filetype = $jResp.StringOf("label_filetype")
$batch_shipmentsNext = $jResp.StringOf("batch_shipments.next")
$batch_shipmentsPrevious = $jResp.StringOf("batch_shipments.previous")
$object_resultsPurchase_succeeded = $jResp.IntOf("object_results.purchase_succeeded")
$object_resultsPurchase_failed = $jResp.IntOf("object_results.purchase_failed")
$object_resultsCreation_failed = $jResp.IntOf("object_results.creation_failed")
$object_resultsCreation_succeeded = $jResp.IntOf("object_results.creation_succeeded")
$i = 0
$count_i = $jResp.SizeOfArray("batch_shipments.results")
while ($i -lt $count_i) {
    $jResp.I = $i
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("label_url")
while ($i -lt $count_i) {
    $jResp.I = $i
    $i = $i + 1
}