Chilkat Online Tools

lianja / Afterpay Online US API v2 / Update Shipping Courier

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "100100248"
loHttp.Password = "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"
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("shippedAt","2015-01-01T00:00:00Z")
loJson.UpdateString("name","CourierPost")
loJson.UpdateString("tracking","AA999999999AA")
loJson.UpdateString("priority","STANDARD")

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://api.us-sandbox.afterpay.com/v2/payments/{{id}}/courier",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson
release loSbRequestBody

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": [
  ]
}