Chilkat Online Tools

delphiAx / Afterpay Online US API v2 / Update Shipping Courier

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;

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

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := '100100248';
http.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"
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateString('shippedAt','2015-01-01T00:00:00Z');
json.UpdateString('name','CourierPost');
json.UpdateString('tracking','AA999999999AA');
json.UpdateString('priority','STANDARD');

http.SetRequestHeader('Content-Type','application/json');
http.SetRequestHeader('Accept','application/json');

sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);

resp := http.PTextSb('PUT','https://api.us-sandbox.afterpay.com/v2/payments/{{id}}/courier',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);

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