Access Orders PII
Learn how to access Orders Personally Identifiable Information.
Learn how to use the Orders API to access a customer's Personally Identifiable Information (PII). In the Orders API v2026-01-01, customer PII includes the following:
buyer.buyerEmailbuyer.buyerNameorderItems.fulfillment.packing.giftOption.giftMessageorderItems.product.customization.customizedUrlrecipient.deliveryAddress.namerecipient.deliveryAddress.addressLine1recipient.deliveryAddress.addressLine2recipient.deliveryAddress.addressLine3recipient.deliveryAddress.postalCoderecipient.deliveryAddress.phonerecipient.deliveryAddress.extendedFields
Note
Accessing PII with the Orders API v2026-01-01 does not require a Restricted Data Token (RDT).
Prerequisites
To complete this tutorial, you need:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
Get buyer’s email for orders
| Required roles | Other conditions |
|---|---|
| Direct-to-Consumer Delivery (Restricted) | The order is fulfilled by the merchant. The order is in UNSHIPPED, PARTIALLY_SHIPPED, or SHIPPED status. |
Call the searchOrders operation or the getOrder operation Orders API v2026-01-01. Include the includedData parameter with the BUYER value, along with any other desired data sets. The buyer’s email is in the buyer.buyerEmail response attribute.
Get buyer’s name for orders
| Required roles (at least one) | Other conditions |
|---|---|
| Order is fulfilled by amazon: Tax Invoicing (Restricted) or Tax Remittance (Restricted) Order is fulfilled by merchant: Tax Invoicing (Restricted), Tax Remittance (Restricted), or Direct-to-Consumer Shipping (Restricted) | The order is in UNSHIPPED, PARTIALLY_SHIPPED, or SHIPPED status.In the US, Japan, and Singapore marketplaces, developers with the Tax Invoicing (Restricted) role and the Tax Remittance (Restricted) role are not permitted to access buyer’s name. |
Call the searchOrders operation or the getOrder operation Orders API v2026-01-01. Include the includedData parameter with the BUYER value, along with any other desired data sets. The buyer’s name is in the buyer.buyerName response attribute.
Get gift message for orders
| Required role | Other conditions |
|---|---|
| Direct-to-Consumer Delivery (Restricted) | The order is fulfilled by the merchant. |
Call the searchOrders operation or the getOrder operation Orders API v2026-01-01. Include the includedData parameter with the FULFILLMENT value, along with any other desired data sets. The buyer’s gift message is in the orderItems.fulfillment.packing.giftOption.giftMessage response attribute.
Get buyer customized data for orders
| Required role | Other conditions |
|---|---|
| Direct-to-Consumer Delivery (Restricted) | The order is fulfilled by the merchant. |
Call the searchOrders operation or the getOrder operation Orders API v2026-01-01. The buyer’s customized data is in the orderItems.product.customization.customizedUrl response attribute.
Get recipient’s phone number for orders
| Required role | Other conditions |
|---|---|
| Direct-to-Consumer Delivery (Restricted) | The order is fulfilled by the merchant. The order is in UNSHIPPED, PARTIALLY_SHIPPED, or SHIPPED status. |
Note
The recipient’s phone number may be suppressed even when the above conditions are met if the phone number is no longer needed for fulfillment. For example, the recipient’s phone number is suppressed for a shipped FBM order when the current date is after the latest delivery date.
Call the searchOrders operation or the getOrder operation Orders API v2026-01-01. The recipient’s phone number is in the recipient.deliveryAddress.phone response attribute.
Get restricted portions of recipient’s delivery address
| Required roles (at least one) | Other conditions |
|---|---|
| Order is fulfilled by amazon: Tax Invoicing (Restricted) or Tax Remittance (Restricted) Order is fulfilled by merchant: Tax Invoicing (Restricted), Tax Remittance (Restricted), or Direct-to-Consumer Shipping (Restricted) | The order is in UNSHIPPED, PARTIALLY_SHIPPED, or SHIPPED status.In the US, Japan, and Singapore marketplaces, developers with the Tax Invoicing (Restricted) role and the Tax Remittance (Restricted) role are not permitted to access the recipient's delivery address. |
Note
The recipient's delivery address includes both restricted data and non-restricted data. This tutorial only applies to restricted data. You do not need to meet the preceding conditions to retrieve attributes such as
city,districtOrCounty, orcountryCode.
Call the searchOrders operation or the getOrder operation Orders API v2026-01-01. Include the includedData parameter with the RECIPIENT value, along with any other desired data sets. The recipient’s delivery address is in the recipient.deliveryAddress response attribute, and includes the following restricted values:
recipient.deliveryAddress.namerecipient.deliveryAddress.addressLine1recipient.deliveryAddress.addressLine2recipient.deliveryAddress.addressLine3recipient.deliveryAddress.extendedFields
Updated about 2 hours ago
