Chilkat Online Tools

TCL / Afterpay Online US API v2 / Update Shipping Courier

Back to Collection Items

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]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "100100248"
CkHttp_put_Password $http "117f3fe5a01a0e400f3e4782baf8ffa43a9d21e9217a15f50d545bc72480d081ecaecc1d6a42ac7a785b7437232bd4cf62dbee679b78a75a3892547059018f9b"

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

# The following JSON is sent in the request body.

# {
#   "shippedAt": "2015-01-01T00:00:00Z",
#   "name": "CourierPost",
#   "tracking": "AA999999999AA",
#   "priority": "STANDARD"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "shippedAt" "2015-01-01T00:00:00Z"
CkJsonObject_UpdateString $json "name" "CourierPost"
CkJsonObject_UpdateString $json "tracking" "AA999999999AA"
CkJsonObject_UpdateString $json "priority" "STANDARD"

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.us-sandbox.afterpay.com/v2/payments/{{id}}/courier" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X PUT
	-u '100100248:117f3fe5a01a0e400f3e4782baf8ffa43a9d21e9217a15f50d545bc72480d081ecaecc1d6a42ac7a785b7437232bd4cf62dbee679b78a75a3892547059018f9b'
	-H "Accept: application/json"
	-H "Content-Type: application/json"
	-d '{
	"shippedAt": "2015-01-01T00:00:00Z",
	"name": "CourierPost",
	"tracking": "AA999999999AA",
	"priority": "STANDARD"
}'
https://api.us-sandbox.afterpay.com/v2/payments/{{id}}/courier

Postman Collection Item JSON

{
  "name": "Update Shipping Courier",
  "event": [
    {
      "listen": "test",
      "script": {
        "id": "298e1176-40a1-40ea-adae-d417963f228f",
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"shippedAt\": \"2015-01-01T00:00:00Z\",\n\t\"name\": \"CourierPost\",\n\t\"tracking\": \"AA999999999AA\",\n\t\"priority\": \"STANDARD\"\n}"
    },
    "url": {
      "raw": "https://api.us-sandbox.afterpay.com/v2/payments/{{id}}/courier",
      "protocol": "https",
      "host": [
        "api",
        "us-sandbox",
        "afterpay",
        "com"
      ],
      "path": [
        "v2",
        "payments",
        "{{id}}",
        "courier"
      ]
    },
    "description": "This resource updates a payment with new shipping courier information. The Afterpay customer support team utilise the shipping courier information when enquiring on the outcome of an order."
  },
  "response": [
  ]
}