Tokens API

You use the Tokens API to get a Restricted Data Token (RDT) for restricted resources.

To learn more about the terms that are used in this guide, refer to Terminology.

Restricted operations

Restricted operations return customers' Personally Identifiable Information (PII). You need an RDT to call a restricted operation.

You can call the createRestrictedDataToken operation of the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. Or, if you have a delegatee application, you can get an RDT from a delegator application owned by a developer that you work closely with. In either case, an RDT authorizes you to make calls to operations that return restricted data.

Use cases

The following use case examples are available for the Tokens API:

• Get authorization to access restricted report types with PII information: Get and use an RDT to access restricted report types.
• Get authorization to access PII for bulk orders: Get and use an RDT to access PII for bulk orders
• Get authorization to access PII for order items in an order: Get an order ID and RDT to access PII for order items in an order.
• Delegate authorization to access PII: Authorize a delegatee application to call restricted operations.
• Get authorization to access shipment information for multiple shipments: Get an RDT that provides authorization to get shipment information for any of a selling partner's shipments.

Roles for the Tokens API v2021-03-01