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.buyerEmail
  • buyer.buyerName
  • orderItems.fulfillment.packing.giftOption.giftMessage
  • orderItems.product.customization.customizedUrl
  • recipient.deliveryAddress.name
  • recipient.deliveryAddress.addressLine1
  • recipient.deliveryAddress.addressLine2
  • recipient.deliveryAddress.addressLine3
  • recipient.deliveryAddress.postalCode
  • recipient.deliveryAddress.phone
  • recipient.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:

Get buyer’s email for orders

Required rolesOther 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 stores, 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 roleOther 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 roleOther 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 roleOther 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 stores, 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, or countryCode.

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.name
  • recipient.deliveryAddress.addressLine1
  • recipient.deliveryAddress.addressLine2
  • recipient.deliveryAddress.addressLine3
  • recipient.deliveryAddress.extendedFields

PII Redaction logic

The following tables show PII data availability by country. In the table, Yes means the PII data is available, and No means the PII data is not available.

For US orders

RolesNo Restricted rolesTax Remittance roleTax Invoice roleDirect to Consumer Shipping role
Fulfillment ChannelFBA/FBM OrdersFBA OrdersFBM OrdersFBA OrdersFBM OrdersFBA OrdersFBM Orders
buyer.buyerEmailNoNoNoNoNoNoYes
buyer.buyerNameNoNoNoNoNoNoYes
deliveryAddress.nameNoNoNoNoNoNoYes
deliveryAddress.addressLine1NoNoNoNoNoNoYes
deliveryAddress.addressLine2NoNoNoNoNoNoYes
deliveryAddress.addressLine3NoNoNoNoNoNoYes
deliveryAddress.phoneNoNoNoNoNoNoYes
deliveryAddress.postalCodeNoYesYesNoNoNoYes
deliveryAddress.extendedFieldsNoNoNoNoNoNoYes
orderItem.fulfillment.packing.giftOption.giftMessageNoNoNoNoNoNoYes
orderItem.product.customization.customizedUrlNoNoNoNoNoNoYes
order.tax.taxRegistrationsNoYesYesYesYesNoNo

For Japan and Singapore orders

RolesNo Restricted rolesTax Remittance/Tax Invoice roleDirect to Consumer Shipping role
Fulfillment ChannelFBA/FBM OrdersFBA OrdersFBM OrdersFBA OrdersFBM Orders
buyer.buyerEmailNoNoNoNoYes
buyer.buyerNameNoNoNoNoYes
deliveryAddress.nameNoNoNoNoYes
deliveryAddress.addressLine1NoNoNoNoYes
deliveryAddress.addressLine2NoNoNoNoYes
deliveryAddress.addressLine3NoNoNoNoYes
deliveryAddress.phoneNoNoNoNoYes
deliveryAddress.postalCodeYesYesYesYesYes
deliveryAddress.extendedFieldsNoNoNoNoYes
orderItem.fulfillment.packing.giftOption.giftMessageNoNoNoNoYes
orderItem.product.customization.customizedUrlNoNoNoNoYes
order.tax.taxRegistrationsNoYesYesNoNo

For non-US/Japan/Singapore orders

RolesNo Restricted rolesTax Remittance/Tax Invoice roleDirect to Consumer Shipping role
Fulfillment ChannelFBA/FBM OrdersFBA OrdersFBM OrdersFBA OrdersFBM Orders
buyer.buyerEmailNoNoNoNoYes
buyer.buyerNameNoYesYesNoYes
deliveryAddress.nameNoYesYesNoYes
deliveryAddress.addressLine1NoYesYesNoYes
deliveryAddress.addressLine2NoYesYesNoYes
deliveryAddress.addressLine3NoYesYesNoYes
deliveryAddress.phoneNoNoNoNoYes
deliveryAddress.postalCodeYesYesYesYesYes
deliveryAddress.extendedFieldsNoYesYesNoYes
orderItem.fulfillment.packing.giftOption.giftMessageNoNoNoNoYes
orderItem.product.customization.customizedUrlNoNoNoNoYes
order.tax.taxRegistrationsNoYesYesNoNo

Did this page help you?