createRestrictedDataToken

POST

/tokens/2021-03-01/restrictedDataToken

tokens

Last modified:2024-11-29 11:21:47

Maintainer:Not configured

Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations.

Usage Plan:

Rate (requests per second)	Burst
1	10

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Header Params

x-amz-access-token

string

optional

Example:

Body Params application/json

The request schema for the createRestrictedDataToken operation.

targetApplication

string

optional

The application ID for the target application to which access is being delegated.

restrictedResources

array[object (RestrictedResource) {3}]

required

A list of restricted resources.
Maximum: 50

method

enum<string>

required

The HTTP method in the restricted resource.

Allowed values:

GETPUTPOSTDELETE

path

string

required

The path in the restricted resource. Here are some path examples:

/orders/v0/orders. For getting an RDT for the getOrders operation of the Orders API. For bulk orders.

/orders/v0/orders/123-1234567-1234567. For getting an RDT for the getOrder operation of the Orders API. For a specific order.

/orders/v0/orders/123-1234567-1234567/orderItems. For getting an RDT for the getOrderItems operation of the Orders API. For the order items in a specific order.

/mfn/v0/shipments/FBA1234ABC5D. For getting an RDT for the getShipment operation of the Shipping API. For a specific shipment.

/mfn/v0/shipments/{shipmentId}. For getting an RDT for the getShipment operation of the Shipping API. For any of a selling partner's shipments that you specify when you call the getShipment operation.

dataElements

array[string]

optional

Indicates the type of Personally Identifiable Information requested. This parameter is required only when getting an RDT for use with the getOrder, getOrders, or getOrderItems operation of the Orders API. For more information, see the Tokens API Use Case Guide. Possible values include:

buyerInfo. On the order level this includes general identifying information about the buyer and tax-related information. On the order item level this includes gift wrap information and custom order information, if available.

shippingAddress. This includes information for fulfilling orders.

buyerTaxInformation. This includes information for issuing tax invoices.

Example

{
    "targetApplication": "amzn1.sellerapps.app.target-application",
    "restrictedResources": [
        {
            "method": "GET",
            "path": "/orders/v0/orders/{orderId}/address"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/tokens/2021-03-01/restrictedDataToken' \
--header 'x-amz-access-token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "targetApplication": "amzn1.sellerapps.app.target-application",
    "restrictedResources": [
        {
            "method": "GET",
            "path": "/orders/v0/orders/{orderId}/address"
        }
    ]
}'

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the createRestrictedDataToken operation.

restrictedDataToken

string

optional

A Restricted Data Token (RDT). This is a short-lived access token that authorizes calls to restricted operations. Pass this value with the x-amz-access-token header when making subsequent calls to these restricted resources.

expiresIn

integer

optional

The lifetime of the Restricted Data Token, in seconds.

Example

{
    "restrictedDataToken": "string",
    "expiresIn": 0
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

updateSupplySourceStatus

createUploadDestinationForResource