Accedi

Ti ringraziamo per la visita. Questa pagina è per il momento disponibile solo in inglese.

Delivery Tracker

Amazon Pay uses the Delivery Tracker object to inform the buyer on Alexa when shipments are out for delivery and when they are delivered.

Supported operations:

Delivery Tracker object
Create Delivery Tracker

Delivery Tracker object

Parameter	Description
amazonOrderReferenceId - or - chargePermissionId (required) Type: string	The Amazon Order Reference ID or Charge Permission ID associated with the order for which the shipments need to be tracked
deliveryDetails Type: deliveryDetail	Shipment delivery details

Type: deliveryDetail

Parameter	Description
carrierCode (required) Type: string	The shipping company code used for delivering goods to the customer. Download carrierCode list
trackingNumber (required) Type: string	The tracking number for the shipment provided by the shipping company

Operations

Create Delivery Tracker

Create a Delivery Tracker once an order has been shipped and a tracking code has been generated. The buyer will receive a notification on their Alexa-enabled device when the order is shipped and when the order is delivered. Note that tracking codes can only be used once.

Request

<?php
include 'vendor/autoload.php';

$amazonpay_config = array(
    'public_key_id' => 'YOUR_PUBLIC_KEY_ID',
    'private_key'   => 'keys/private.pem',
    'region'        => 'YOUR_REGION_CODE',
    'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2'
);
$payload = array(
    'amazonOrderReferenceId' => 'P00-0000000-0000000',
    'deliveryDetails' => array(array(
        'trackingNumber' => '1Z999AA10123456784',
        'carrierCode' => 'UPS'
    ))
);
try {
  $client = new Amazon\Pay\API\Client($amazonpay_config);
  $result = $client->deliveryTrackers($payload);
  if ($result['status'] === 200) {
      // success
      echo $result['response'] . "\n";
  } else {
    // check the error
    echo 'status=' . $result['status'] . '; response=' . $result['response'] . "\n";
  }
} catch (\Exception $e) {
  // handle the exception
  echo $e . "\n";
}
?>


AmazonPayResponse response = null;

JSONObject payload = new JSONObject();
JSONObject deliveryDetails = new JSONObject();
JSONArray deliveryDetailsArray = new JSONArray();
deliveryDetails.put("trackingNumber", "1Z999AA10123456784");
deliveryDetails.put("carrierCode", "UPS");
deliveryDetailsArray.add(deliveryDetails);
payload.put("amazonOrderReferenceId", "P00-0000000-0000000");
payload.put("deliveryDetails", deliveryDetailsArray);

try {
    response = client.deliveryTracker(payload);
} catch (AmazonPayClientException e) {
    e.printStackTrace();
}

// prepare the request
var request = new DeliveryTrackerRequest
(
    objectId: "P00-0000000-0000000", // ChargePermissionID or OrderReferenceID
    objectIsChargePermission: true,  // true if above is ChargePermissionID, false otherwise 
    trackingNumber: "1Z999AA10123456784", 
    carrierCode: "UPS"
);
// generate the button signature
var result = client.SendDeliveryTrackingInformation(request);
// check if API call was successful
if (!result.Success)
{
    // do something, e.g. throw an error
}

return result;

const fs = require('fs');
const Client = require('../src/client');

const config = {
    publicKeyId: 'YOUR_PUBLIC_KEY_ID',
    privateKey: fs.readFileSync('tst/private.pem'),
    region: 'YOUR_REGION_CODE',
    algorithm: 'AMZN-PAY-RSASSA-PSS-V2'
};

const payload = {
    amazonOrderReferenceId: 'P00-0000000-0000000',
    deliveryDetails: [{
        trackingNumber: '1Z999AA10123456789',
        carrierCode: 'UPS'
    }]
};

const testPayClient = new Client.AmazonPayClient(config);
const response = testPayClient.deliveryTrackers(payload);


POST /:version/deliveryTrackers HTTP/1.1
Host: pay-api.amazon.com
Accept: application/json
Authorization: AMZN-PAY-RSASSA-PSS-V2 PublicKeyId=f4fc06fc-c5a7-11e7-abc4-cec278b6b50a, SignedHeaders=content-type;x-amz-pay-date;x-amz-pay-region, Signature=4164128ec5d1b9da1700167ab2ccda8125f472c8bb9de447cebf5d741ee317c8       
X-Amz-Pay-Date: 20190305T024410Z
Content-type: application/json

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

<?php
include 'vendor/autoload.php';

$amazonpay_config = array(
  'public_key_id' => 'MY_PUBLIC_KEY_ID',
  'private_key'   => 'keys/private.pem',
  'region'        => 'US',
  'sandbox'       => false,
  'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2'
);
$payload = array(
  'amazonOrderReferenceId' => 'P00-0000000-0000000',
  'deliveryDetails' => array(array(
      'trackingNumber' => '1Z999AA10123456784',
      'carrierCode' => 'UPS'
  ))
);
try {
  $client = new Amazon\Pay\API\Client($amazonpay_config);
  $result = $client->deliveryTrackers($payload);
  if ($result['status'] === 200) {
      // success
      echo $result['response'] . "\n";
  } else {
    // check the error
    echo 'status=' . $result['status'] . '; response=' . $result['response'] . "\n";
  }
} catch (\Exception $e) {
  // handle the exception
  echo $e . "\n";
}
?>


AmazonPayResponse response = null;

JSONObject payload = new JSONObject();
JSONObject deliveryDetails = new JSONObject();
JSONArray deliveryDetailsArray = new JSONArray();
deliveryDetails.put("trackingNumber", "1Z999AA10123456784");
deliveryDetails.put("carrierCode", "UPS");
deliveryDetailsArray.add(deliveryDetails);
payload.put("amazonOrderReferenceId", "P00-0000000-0000000");
payload.put("deliveryDetails", deliveryDetailsArray);

try {
    response = client.deliveryTracker(payload);
} catch (AmazonPayClientException e) {
    e.printStackTrace();
}

// prepare the request
var request = new DeliveryTrackerRequest
(
    objectId: "P00-0000000-0000000", // ChargePermissionID or OrderReferenceID
    objectIsChargePermission: true,  // true if above is ChargePermissionID, false otherwise 
    trackingNumber: "1Z999AA10123456784", 
    carrierCode: "UPS"
);
// generate the button signature
var result = client.SendDeliveryTrackingInformation(request);
// check if API call was successful
if (!result.Success)
{
    // do something, e.g. throw an error
}

return result;

const fs = require('fs');
const Client = require('../src/client');

const config = {
    publicKeyId: 'YOUR_PUBLIC_KEY_ID',
    privateKey: fs.readFileSync('tst/private.pem'),
    region: 'us',
    sandbox: true,
    algorithm: 'AMZN-PAY-RSASSA-PSS-V2'
};

const payload = {
    amazonOrderReferenceId: 'P00-0000000-0000000',
    deliveryDetails: [{
        trackingNumber: '1Z999AA10123456789',
        carrierCode: 'UPS'
    }]
};

const testPayClient = new Client.AmazonPayClient(config);
const response = testPayClient.deliveryTrackers(payload);


POST /live/v2/deliveryTrackers HTTP/1.1
Host: pay-api.amazon.com
Accept: application/json
Authorization: AMZN-PAY-RSASSA-PSS-V2 PublicKeyId=f4fc06fc-c5a7-11e7-abc4-cec278b6b50a, SignedHeaders=content-type;x-amz-pay-date;x-amz-pay-region, Signature=4164128ec5d1b9da1700167ab2ccda8125f472c8bb9de447cebf5d741ee317c8       
X-Amz-Pay-Date: 20190305T024410Z
Content-type: application/json

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

Request parameters

Name	Location	Description
amazonOrderReferenceId - or - chargePermissionId (required) Type: string	Body	The Amazon Order Reference ID or Charge Permission ID associated with the order for which the shipments need to be tracked
carrierCode (required) Type: string	Body	The shipping company code used for delivering goods to the customer. Download carrierCode list
trackingNumber (required) Type: string	Body	The tracking number for the shipment provided by the shipping company

Response

Returns HTTP 200 status response code if the operation was successful.

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

Error codes

HTTP status code	Reason code	Description
400 BAD_REQUEST	InvalidInputFormat	The token provided is expired, revoked, malformed, or invalid for some other reason
400 BAD_REQUEST	InvalidParameterValue	The `amazonOrderReferenceId` that you submitted in this request is invalid
400 BAD_REQUEST	InvalidParameterValue	The `trackingNumber` or `carrierCode` that you submitted in this request is invalid

Generic errors can be found here.