(PHP Extension) Amazon Pay - Create Delivery Tracker

See more Amazon Pay Examples

Create a Delivery Tracker once an order has been shipped and a tracking code has been generated.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/delivery-tracker.html#button_widget_other

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$http = new CkHttp();

// Implements the following POST:

// POST /:version/deliveryTrackers HTTP/1.1
// Host: pay-api.amazon.com
// Accept: application/json
// Authorization: AMZN-PAY-RSASSA-PSS PublicKeyId=f4fc06fc-c5a7-11e7-abc4-cec278b6b50a, SignedHeaders=content-type;x-amz-pay-date, Signature=4164128ec5d1b9da1700167ab2ccda8125f472c8bb9de447cebf5d741ee317c8       
// X-Amz-Pay-Date: 20190305T024410Z
// Content-type: application/json
// 
// {
//     "amazonOrderReferenceId" : "P00-0000000-0000000",
//     "deliveryDetails" : [{
//     "trackingNumber" : "1Z999AA10123456784",
//     "carrierCode" : "UPS"
//   }]
// }

// Use the following online tool to generate HTTP code from a CURL command
// Convert a Raw HTTP Request to Source Code

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

// The following JSON is sent in the request body.

// {
//     "amazonOrderReferenceId" : "P00-0000000-0000000",
//     "deliveryDetails" : [{
//     "trackingNumber" : "1Z999AA10123456784",
//     "carrierCode" : "UPS"
//   }]
// }

$json = new CkJsonObject();
$json->UpdateString('amazonOrderReferenceId','P00-0000000-0000000');
$json->UpdateString('deliveryDetails[0].trackingNumber','1Z999AA10123456784');
$json->UpdateString('deliveryDetails[0].carrierCode','UPS');

// Load your Amazon Pay private key.  
// There are many other ways to load private keys into the Chilkat private key object, such as from different formats,
// or from in-memory strings or bytes.
$privKey = new CkPrivateKey();
$success = $privKey->LoadPemFile('C:/someDir/myAmazonPayPrivateKey.pem');
if ($success == false) {
    print $privKey->lastErrorText() . "\n";
    exit;
}

// Provide your Amazon Pay private key and Public Key ID 
// Use your public key ID here.  It must be the one associated with the private key.
// Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
$publicKeyId = 'SANDBOX-AHEGSJCM3L2S637RBGABLAFW';
$success = $http->SetAuthPrivateKey($publicKeyId,$privKey);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

// Note: When the private key is provided as shown above, Chilkat will automatically add the required x-amz-pay-* headers to the HTTP request,
// and will also sign the request.  Nothing more is needed.
// Chilkat automatically generates and adds the following headers:
// 
// x-amz-pay-date
// x-amz-pay-host
// x-amz-pay-region
// x-amz-pay-idempotency-key
// Authorization

$http->put_Accept('application/json');

// To use the live system, replace "sandbox" with "live" in the URL passed to PostJson3.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://pay-api.amazon.eu/sandbox/v2/deliveryTrackers','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

// If the status code is not equal to 200, this will display error information.
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode != 200) {
    print 'Failed.' . "\n";

    exit;
}

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

// {
//     "amazonOrderReferenceId": "P00-0000000-0000000",
//     "deliveryDetails": [{
//         "trackingNumber": "1Z999AA10123456784",
//         "carrierCode": "UPS"
//     }]
// }

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

$amazonOrderReferenceId = $jResp->stringOf('amazonOrderReferenceId');
$i = 0;
$count_i = $jResp->SizeOfArray('deliveryDetails');
while ($i < $count_i) {
    $jResp->put_I($i);
    $trackingNumber = $jResp->stringOf('deliveryDetails[i].trackingNumber');
    $carrierCode = $jResp->stringOf('deliveryDetails[i].carrierCode');
    $i = $i + 1;
}


?>