Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "order": {
// "external_order_identifier": "ABC-105",
// "ordered_at": "2014-01-16 14:37:56 -0600",
// "order_status": "awaiting_shipment",
// "subtotal_including_tax": "10.00",
// "total_including_tax": "10.00",
// "total_excluding_tax": "10.00",
// "discount_amount": "0.00",
// "coupon_discount": "1.00",
// "subtotal_excluding_tax": "0.00",
// "subtotal_tax": "0.00",
// "total_tax": "0",
// "base_shipping_cost": "0.00",
// "shipping_cost_including_tax": "0.00",
// "shipping_cost_excluding_tax": "0.00",
// "shipping_cost_tax": "0.00",
// "base_handling_cost": "0.00",
// "handling_cost_excluding_tax": "0.00",
// "handling_cost_including_tax": "0.00",
// "handling_cost_tax": "0.00",
// "base_wrapping_cost": "0.00",
// "wrapping_cost_excluding_tax": "0.00",
// "wrapping_cost_including_tax": "0.00",
// "wrapping_cost_tax": "0.00",
// "notes": "Please send promptly.",
// "billing_company": "Acme Inc.",
// "billing_first_name": "Fred",
// "billing_last_name": "Jones",
// "billing_address": "1234 Street",
// "billing_address2": "Suite 100",
// "billing_city": "Austin",
// "billing_state": "TX",
// "billing_postal_code": "78701",
// "billing_country": "USA",
// "billing_phone_number": "512-123-1234",
// "billing_email": "test@test.com",
// "recipients": [
// {
// "first_name": "Jack",
// "last_name": "Ship",
// "company": "ShippingEasy",
// "email": "jack@shippingeasy.com",
// "phone_number": "855-202-2275",
// "residential": "true",
// "address": "3700 N Capital of Texas Hwy Ste 550",
// "address2": "",
// "province": "",
// "state": "TX",
// "city": "Austin",
// "postal_code": "78746",
// "postal_code_plus_4": "1234",
// "country": "United States",
// "shipping_method": "Ground",
// "base_cost": "10.00",
// "cost_excluding_tax": "10.00",
// "cost_tax": "0.00",
// "base_handling_cost": "0.00",
// "handling_cost_excluding_tax": "0.00",
// "handling_cost_including_tax": "0.00",
// "handling_cost_tax": "0.00",
// "shipping_zone_id": "123",
// "shipping_zone_name": "XYZ",
// "items_total": "1",
// "items_shipped": "0",
// "line_items": [
// {
// "item_name": "Pencil Holder",
// "sku": "9876543",
// "bin_picking_number": "7",
// "unit_price": "1.30",
// "total_excluding_tax": "1.30",
// "weight_in_ounces": "10",
// "product_options": {
// "pa_size": "large",
// "Colour": "Blue"
// },
// "quantity": "1"
// }
// ]
// }
// ]
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "order.external_order_identifier" "ABC-105" To iSuccess
Get ComUpdateString Of hoJson "order.ordered_at" "2014-01-16 14:37:56 -0600" To iSuccess
Get ComUpdateString Of hoJson "order.order_status" "awaiting_shipment" To iSuccess
Get ComUpdateString Of hoJson "order.subtotal_including_tax" "10.00" To iSuccess
Get ComUpdateString Of hoJson "order.total_including_tax" "10.00" To iSuccess
Get ComUpdateString Of hoJson "order.total_excluding_tax" "10.00" To iSuccess
Get ComUpdateString Of hoJson "order.discount_amount" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.coupon_discount" "1.00" To iSuccess
Get ComUpdateString Of hoJson "order.subtotal_excluding_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.subtotal_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.total_tax" "0" To iSuccess
Get ComUpdateString Of hoJson "order.base_shipping_cost" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.shipping_cost_including_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.shipping_cost_excluding_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.shipping_cost_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.base_handling_cost" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.handling_cost_excluding_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.handling_cost_including_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.handling_cost_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.base_wrapping_cost" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.wrapping_cost_excluding_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.wrapping_cost_including_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.wrapping_cost_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.notes" "Please send promptly." To iSuccess
Get ComUpdateString Of hoJson "order.billing_company" "Acme Inc." To iSuccess
Get ComUpdateString Of hoJson "order.billing_first_name" "Fred" To iSuccess
Get ComUpdateString Of hoJson "order.billing_last_name" "Jones" To iSuccess
Get ComUpdateString Of hoJson "order.billing_address" "1234 Street" To iSuccess
Get ComUpdateString Of hoJson "order.billing_address2" "Suite 100" To iSuccess
Get ComUpdateString Of hoJson "order.billing_city" "Austin" To iSuccess
Get ComUpdateString Of hoJson "order.billing_state" "TX" To iSuccess
Get ComUpdateString Of hoJson "order.billing_postal_code" "78701" To iSuccess
Get ComUpdateString Of hoJson "order.billing_country" "USA" To iSuccess
Get ComUpdateString Of hoJson "order.billing_phone_number" "512-123-1234" To iSuccess
Get ComUpdateString Of hoJson "order.billing_email" "test@test.com" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].first_name" "Jack" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].last_name" "Ship" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].company" "ShippingEasy" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].email" "jack@shippingeasy.com" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].phone_number" "855-202-2275" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].residential" "true" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].address" "3700 N Capital of Texas Hwy Ste 550" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].address2" "" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].province" "" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].state" "TX" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].city" "Austin" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].postal_code" "78746" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].postal_code_plus_4" "1234" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].country" "United States" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].shipping_method" "Ground" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].base_cost" "10.00" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].cost_excluding_tax" "10.00" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].cost_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].base_handling_cost" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].handling_cost_excluding_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].handling_cost_including_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].handling_cost_tax" "0.00" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].shipping_zone_id" "123" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].shipping_zone_name" "XYZ" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].items_total" "1" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].items_shipped" "0" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].line_items[0].item_name" "Pencil Holder" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].line_items[0].sku" "9876543" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].line_items[0].bin_picking_number" "7" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].line_items[0].unit_price" "1.30" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].line_items[0].total_excluding_tax" "1.30" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].line_items[0].weight_in_ounces" "10" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].line_items[0].product_options.pa_size" "large" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].line_items[0].product_options.Colour" "Blue" To iSuccess
Get ComUpdateString Of hoJson "order.recipients[0].line_items[0].quantity" "1" To iSuccess
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
Get pvComObject of hoJson to vJson
Get pvComObject of hoResp to vResp
Get ComHttpJson Of hoHttp "POST" "Key}}" vJson "application/json" vResp To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
End_Procedure
Curl Command
curl -X POST
-d '{
"order": {
"external_order_identifier": "ABC-105",
"ordered_at": "2014-01-16 14:37:56 -0600",
"order_status": "awaiting_shipment",
"subtotal_including_tax": "10.00",
"total_including_tax": "10.00",
"total_excluding_tax": "10.00",
"discount_amount": "0.00",
"coupon_discount": "1.00",
"subtotal_excluding_tax": "0.00",
"subtotal_tax": "0.00",
"total_tax": "0",
"base_shipping_cost": "0.00",
"shipping_cost_including_tax": "0.00",
"shipping_cost_excluding_tax": "0.00",
"shipping_cost_tax": "0.00",
"base_handling_cost": "0.00",
"handling_cost_excluding_tax": "0.00",
"handling_cost_including_tax": "0.00",
"handling_cost_tax": "0.00",
"base_wrapping_cost": "0.00",
"wrapping_cost_excluding_tax": "0.00",
"wrapping_cost_including_tax": "0.00",
"wrapping_cost_tax": "0.00",
"notes": "Please send promptly.",
"billing_company": "Acme Inc.",
"billing_first_name": "Fred",
"billing_last_name": "Jones",
"billing_address": "1234 Street",
"billing_address2": "Suite 100",
"billing_city": "Austin",
"billing_state": "TX",
"billing_postal_code": "78701",
"billing_country": "USA",
"billing_phone_number": "512-123-1234",
"billing_email": "test@test.com",
"recipients": [
{
"first_name": "Jack",
"last_name": "Ship",
"company": "ShippingEasy",
"email": "jack@shippingeasy.com",
"phone_number": "855-202-2275",
"residential": "true",
"address": "3700 N Capital of Texas Hwy Ste 550",
"address2": "",
"province": "",
"state": "TX",
"city": "Austin",
"postal_code": "78746",
"postal_code_plus_4": "1234",
"country": "United States",
"shipping_method": "Ground",
"base_cost": "10.00",
"cost_excluding_tax": "10.00",
"cost_tax": "0.00",
"base_handling_cost": "0.00",
"handling_cost_excluding_tax": "0.00",
"handling_cost_including_tax": "0.00",
"handling_cost_tax": "0.00",
"shipping_zone_id": "123",
"shipping_zone_name": "XYZ",
"items_total": "1",
"items_shipped": "0",
"line_items": [
{
"item_name": "Pencil Holder",
"sku": "9876543",
"bin_picking_number": "7",
"unit_price": "1.30",
"total_excluding_tax": "1.30",
"weight_in_ounces": "10",
"product_options": {
"pa_size": "large",
"Colour": "Blue"
},
"quantity": "1"
}
]
}
]
}
}'
https://app.shippingeasy.com/api/stores/{{Store API Key}}/orders?api_signature={{api_signature}}&api_timestamp={{api_timestamp}}&api_key={{API Key}}
Postman Collection Item JSON
{
"name": "Create Order",
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
"// calculate timestamp",
"const timestamp = parseInt(Date.now() / 1000);",
"console.log(\"timestamp: \" + timestamp);",
"pm.variables.set(\"api_timestamp\", timestamp);",
"",
"// Set your API key and API secret as Postman environment variables, your key and secret are available at https://app.shippingeasy.com/settings/api_credentials",
"const apiKey = pm.environment.get(\"API Key\");",
"const apiSecret = pm.environment.get(\"API Secret\");",
"const storeApiKey = pm.environment.get(\"Store API Key\");",
"",
"// build signature string - https://shippingeasy.readme.io/docs/authentication-signing-requests#how-to-calculate-a-signature",
"const signatureString = pm.request.method + \"&\" +",
" \"/api/stores/\" + storeApiKey + \"/orders&\" +",
" \"api_key=\" + apiKey + \"&\" +",
" \"api_timestamp=\" + timestamp + \"&\" +",
" pm.request.body.toString();",
"console.log(\"signature string: \" + signatureString);",
"",
"// generate signature",
"const apiSignature = CryptoJS.HmacSHA256(signatureString, apiSecret).toString(CryptoJS.enc.Hex);",
"console.log(\"api request signature: \" + apiSignature);",
"pm.variables.set(\"api_signature\", apiSignature);"
]
}
}
],
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"order\": {\n \"external_order_identifier\": \"ABC-105\",\n \"ordered_at\": \"2014-01-16 14:37:56 -0600\",\n \"order_status\": \"awaiting_shipment\",\n \"subtotal_including_tax\": \"10.00\",\n \"total_including_tax\": \"10.00\",\n \"total_excluding_tax\": \"10.00\",\n \"discount_amount\": \"0.00\",\n \"coupon_discount\": \"1.00\",\n \"subtotal_excluding_tax\": \"0.00\",\n \"subtotal_tax\": \"0.00\",\n \"total_tax\": \"0\",\n \"base_shipping_cost\": \"0.00\",\n \"shipping_cost_including_tax\": \"0.00\",\n \"shipping_cost_excluding_tax\": \"0.00\",\n \"shipping_cost_tax\": \"0.00\",\n \"base_handling_cost\": \"0.00\",\n \"handling_cost_excluding_tax\": \"0.00\",\n \"handling_cost_including_tax\": \"0.00\",\n \"handling_cost_tax\": \"0.00\",\n \"base_wrapping_cost\": \"0.00\",\n \"wrapping_cost_excluding_tax\": \"0.00\",\n \"wrapping_cost_including_tax\": \"0.00\",\n \"wrapping_cost_tax\": \"0.00\",\n \"notes\": \"Please send promptly.\",\n \"billing_company\": \"Acme Inc.\",\n \"billing_first_name\": \"Fred\",\n \"billing_last_name\": \"Jones\",\n \"billing_address\": \"1234 Street\",\n \"billing_address2\": \"Suite 100\",\n \"billing_city\": \"Austin\",\n \"billing_state\": \"TX\",\n \"billing_postal_code\": \"78701\",\n \"billing_country\": \"USA\",\n \"billing_phone_number\": \"512-123-1234\",\n \"billing_email\": \"test@test.com\",\n \"recipients\": [\n {\n \"first_name\": \"Jack\",\n \"last_name\": \"Ship\",\n \"company\": \"ShippingEasy\",\n \"email\": \"jack@shippingeasy.com\",\n \"phone_number\": \"855-202-2275\",\n \"residential\": \"true\",\n \"address\": \"3700 N Capital of Texas Hwy Ste 550\",\n \"address2\": \"\",\n \"province\": \"\",\n \"state\": \"TX\",\n \"city\": \"Austin\",\n \"postal_code\": \"78746\",\n \"postal_code_plus_4\": \"1234\",\n \"country\": \"United States\",\n \"shipping_method\": \"Ground\",\n \"base_cost\": \"10.00\",\n \"cost_excluding_tax\": \"10.00\",\n \"cost_tax\": \"0.00\",\n \"base_handling_cost\": \"0.00\",\n \"handling_cost_excluding_tax\": \"0.00\",\n \"handling_cost_including_tax\": \"0.00\",\n \"handling_cost_tax\": \"0.00\",\n \"shipping_zone_id\": \"123\",\n \"shipping_zone_name\": \"XYZ\",\n \"items_total\": \"1\",\n \"items_shipped\": \"0\",\n \"line_items\": [\n {\n \"item_name\": \"Pencil Holder\",\n \"sku\": \"9876543\",\n \"bin_picking_number\": \"7\",\n \"unit_price\": \"1.30\",\n \"total_excluding_tax\": \"1.30\",\n \"weight_in_ounces\": \"10\",\n \"product_options\": {\n \"pa_size\": \"large\",\n \"Colour\": \"Blue\"\n },\n \"quantity\": \"1\"\n }\n ]\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "app.shippingeasy.com/api/stores/{{Store API Key}}/orders?api_signature={{api_signature}}&api_timestamp={{api_timestamp}}&api_key={{API Key}}",
"host": [
"app",
"shippingeasy",
"com"
],
"path": [
"api",
"stores",
"{{Store API Key}}",
"orders"
],
"query": [
{
"key": "api_signature",
"value": "{{api_signature}}"
},
{
"key": "api_timestamp",
"value": "{{api_timestamp}}"
},
{
"key": "api_key",
"value": "{{API Key}}"
}
]
},
"description": "Create an order in ShippingEasy."
},
"response": [
]
}
