(Tcl) Shippo Create an Order

Demonstrates how to create an order with all the information about your order by sending a POST request to the orders endpoint.

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# Implements the following CURL command:

# curl https://api.goshippo.com/orders/ \
#     -H "Authorization: ShippoToken <API_Token>" \
#     -H "Content-Type: application/json"  \
#     -d '{
#             "to_address": {
#                 "city": "San Francisco",
#                 "company": "Shippo",
#                 "country": "US",
#                 "email": "shippotle@goshippo.com",
#                 "name": "Mr Hippo",
#                 "phone": "15553419393",
#                 "state": "CA",
#                 "street1": "215 Clayton St.",
#                 "zip": "94117"
#             },
#             "line_items": [
#                 {
#                     "quantity": 1,
#                     "sku": "HM-123",
#                     "title": "Hippo Magazines",
#                     "total_price": "12.10",
#                     "currency": "USD",
#                     "weight": "0.40",
#                     "weight_unit": "lb"
#                 }
#             ],
#             "placed_at": "2016-09-23T01:28:12Z",
#             "order_number": "#1068",
#             "order_status": "PAID",
#             "shipping_cost": "12.83",
#             "shipping_cost_currency": "USD",
#             "shipping_method": "USPS First Class Package",
#             "subtotal_price": "12.10",
#             "total_price": "24.93",
#             "total_tax": "0.00",
#             "currency": "USD",
#             "weight": "0.40",
#             "weight_unit": "lb"
#         }'

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

# The following JSON is sent in the request body.

# {
#   "to_address": {
#     "city": "San Francisco",
#     "company": "Shippo",
#     "country": "US",
#     "email": "shippotle@goshippo.com",
#     "name": "Mr Hippo",
#     "phone": "15553419393",
#     "state": "CA",
#     "street1": "215 Clayton St.",
#     "zip": "94117"
#   },
#   "line_items": [
#     {
#       "quantity": 1,
#       "sku": "HM-123",
#       "title": "Hippo Magazines",
#       "total_price": "12.10",
#       "currency": "USD",
#       "weight": "0.40",
#       "weight_unit": "lb"
#     }
#   ],
#   "placed_at": "2016-09-23T01:28:12Z",
#   "order_number": "#1068",
#   "order_status": "PAID",
#   "shipping_cost": "12.83",
#   "shipping_cost_currency": "USD",
#   "shipping_method": "USPS First Class Package",
#   "subtotal_price": "12.10",
#   "total_price": "24.93",
#   "total_tax": "0.00",
#   "currency": "USD",
#   "weight": "0.40",
#   "weight_unit": "lb"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "to_address.city" "San Francisco"
CkJsonObject_UpdateString $json "to_address.company" "Shippo"
CkJsonObject_UpdateString $json "to_address.country" "US"
CkJsonObject_UpdateString $json "to_address.email" "shippotle@goshippo.com"
CkJsonObject_UpdateString $json "to_address.name" "Mr Hippo"
CkJsonObject_UpdateString $json "to_address.phone" "15553419393"
CkJsonObject_UpdateString $json "to_address.state" "CA"
CkJsonObject_UpdateString $json "to_address.street1" "215 Clayton St."
CkJsonObject_UpdateString $json "to_address.zip" "94117"
CkJsonObject_UpdateInt $json "line_items[0].quantity" 1
CkJsonObject_UpdateString $json "line_items[0].sku" "HM-123"
CkJsonObject_UpdateString $json "line_items[0].title" "Hippo Magazines"
CkJsonObject_UpdateString $json "line_items[0].total_price" "12.10"
CkJsonObject_UpdateString $json "line_items[0].currency" "USD"
CkJsonObject_UpdateString $json "line_items[0].weight" "0.40"
CkJsonObject_UpdateString $json "line_items[0].weight_unit" "lb"
CkJsonObject_UpdateString $json "placed_at" "2016-09-23T01:28:12Z"
CkJsonObject_UpdateString $json "order_number" "#1068"
CkJsonObject_UpdateString $json "order_status" "PAID"
CkJsonObject_UpdateString $json "shipping_cost" "12.83"
CkJsonObject_UpdateString $json "shipping_cost_currency" "USD"
CkJsonObject_UpdateString $json "shipping_method" "USPS First Class Package"
CkJsonObject_UpdateString $json "subtotal_price" "12.10"
CkJsonObject_UpdateString $json "total_price" "24.93"
CkJsonObject_UpdateString $json "total_tax" "0.00"
CkJsonObject_UpdateString $json "currency" "USD"
CkJsonObject_UpdateString $json "weight" "0.40"
CkJsonObject_UpdateString $json "weight_unit" "lb"

CkHttp_SetRequestHeader $http "Authorization" "ShippoToken <API_Token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.goshippo.com/orders/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

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

# {}

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


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp