createRestrictedDataToken

POST

/tokens/2021-03-01/restrictedDataToken

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

Body Params application/json

Example

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

Request Code 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

Body

Example

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

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Modified at 2024-11-29 11:21:47

updateSupplySourceStatus

createUploadDestinationForResource