ログイン

Alexa配送通知機能の設定

Create Delivery TrackerAPIを利用して配送追跡用の情報を提供することで、購入者が配送に関する通知を受け取ることができるようになります。この API はチャネル非依存です。つまり、Amazon Pay をどこで使用しても、Delivery Tracker API を使うことができます。

Delivery Tracker API での購入者エクスペリエンス
Ecommerce plugins
インテグレーションステップ

Delivery Tracker API での購入者エクスペリエンス

こちらが購入者のエクスペリエンスになります。

購入者: アレクサ, 通知を読んで。

配達中通知 Alexa: Amazon Pay から通知が１件あります。 [セラーセントラルに登録された店舗名] からの商品は [date]までに到着予定です。

配達済み通知 Alexa: Amazon Pay から通知が１件あります。 [セラーセントラルに登録された店舗名] からの配達が完了しました。

Ecommerce plugins

ご自身でDelivery TrackerのAPIをインテグレーションする事もできますし、下記のお客様の地域に合わせてあらかじめ構築されたソリューションを利用することもできます。

Ecommerce solution	Resources	Min. plugin version
Magento 1	インストール手順とドキュメント	3.0.14
Magento 2	インストール手順とドキュメント	1.0.0

Ecommerce solution	Resources	Min. plugin version
Magento 1	インストール手順とドキュメント	3.0.14
Magento 2	インストール手順とドキュメント	1.0.0
PrestaShop	インストール手順とドキュメント	2.3.2 (PrestaShop 1.6) 3.3.0 (PrestaShop 1.7)
JTL Shop 4	インストール手順とドキュメント	1.0.0

現在、未対応です

インテグレーションステップ

1. Delivery Trackerの作成

Amazonの chargePermissionId, 配送会社のcarrierCodeとtrackingNumberと共にCreate Delivery Trackerを呼び出し、Alexa配送通知機能を有効にします

リクエスト

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

$amazonpay_config = array(
  'public_key_id' => 'MY_PUBLIC_KEY_ID',
  'private_key'   => 'keys/private.pem',
  'region'        => 'US',
  'sandbox'       => false
);
$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: 'ABC123DEF456XYZ',
    privateKey: fs.readFileSync('tst/private.pem'),
    region: 'us',
    sandbox: true
};

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

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

$amazonpay_config = array(
  'public_key_id' => 'MY_PUBLIC_KEY_ID',
  'private_key'   => 'keys/private.pem',
  'region'        => 'US',
  'sandbox'       => false
);
$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: 'ABC123DEF456XYZ',
    privateKey: fs.readFileSync('tst/private.pem'),
    region: 'us',
    sandbox: true
};

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

リクエストパラメータ

名前	ロケーション	説明
chargePermissionId (必須) Type: string	Body	追跡される配送に紐付くCharge Permission ID
carrierCode (必須) Type: string	Body	商品をお届けする際に使用するcarrier code(配送会社のコード) 配送会社リストのダウンロード
trackingNumber (必須) Type: string	Body	配送会社より提供されたtracking number(お問い合わせ番号・追跡番号)

レスポンス

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

2. インテグレーションのテスト

エンドツーエンドのテストには、Alexa対応のデバイスが必要です。

SANDBOX テスト

SANDBOXでエンドツーエンドのテストを実行することで機能のインテグレーションを確認できますが、実際のAlexa配送通知は送信されません。以下の通りテストができます。

テストオーダーを作成し、chargePermissionIdを保存します。
Create Delivery TrackerをchargePermissionId、ランダムなtracking number(お問い合わせ番号・追跡番号)、carrier code(配送会社のコード)と共に呼び出します。配送会社コードはサポート対象の配送会社のいずれかとなります。
APIがHTTP 200 (OK) statusを返すことを確認します。

本番環境テスト（オプション）

SANDBOXテストが成功すれば、期待どおりにインテグレーションされたことを確認できますが、本番環境テストは、Alexa対応デバイスでの通知を含む完全なエクスペリエンスを確認する唯一の方法です。確認に辺り、以下の前提条件が必要となります。

Alexa対応デバイスは、本番環境の注文に使用しているAmazonアカウントに接続されている必要があります。
Alexaアプリの「設定」→「通知」→「Amazon でお買い物」で、「配送中」と「配達済み」の設定を有効にする必要があります。US以外のお客様の場合、少なくとも一つ以上は Amazon 発送の商品を購入しないと、通知を受け取ることも、こちらの設定を見ることもできません。

注文が発送され、実際のtracking number(お問い合わせ番号・追跡番号)が生成されたら、Create Delivery Trackerを呼び出します。注文が発送されたときと注文が配達されたときに、Alexa対応デバイスに通知が届きます。トラッキングコードは1回しか使用できないことに注意してください。