Thank you for your visit. This page is only available in English at this time.

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

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

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.