createRestrictedDataToken

北美(North America）

https://sellingpartnerapi-na.amazon.com

POST

/tokens/2021-03-01/restrictedDataToken

Tokens

返回一个限制数据令牌（RDT），用于您指定的一个或多个限制资源。限制资源是指从返回个人身份信息（PII）的限制操作中获取的HTTP方法和路径，以及一个dataElements值，该值指示请求的PII类型。有关限制操作的列表，请参阅令牌API用例指南。在后续调用相应的限制操作时，将此处返回的RDT用作访问令牌。

使用计划：

速率（每秒请求数）	峰值
1	10

x-amzn-RateLimit-Limit响应头返回适用于请求操作的使用计划速率限制（如果可用）。上表指示此操作的默认速率和峰值值。业务需求需要更高吞吐量的销售合作伙伴可能会看到比这里显示的更高的速率和峰值值。欲了解更多信息，请参见销售合作伙伴API中的使用计划和速率限制。

请求参数

Body 参数application/json

createRestrictedDataToken操作的请求 schema。

targetApplication

string

可选

要委派访问的目标应用程序的应用程序 ID。

restrictedResources

array[object (RestrictedResource) {3}]

限制资源清单。

必需

method

enum<string>

必需

受限资源中的HTTP方法。

枚举值:

GETPUTPOSTDELETE

path

string

必需

限制资源中的路径。以下是一些路径示例：

/orders/v0/orders。用于获取订单 API 的 getOrders 操作的 RDT。针对批量订单。

/orders/v0/orders/123-1234567-1234567。用于获取订单 API 的 getOrder 操作的 RDT。针对特定订单。

/orders/v0/orders/123-1234567-1234567/orderItems。用于获取订单 API 的 getOrderItems 操作的 RDT。针对特定订单中的订单项。

/mfn/v0/shipments/FBA1234ABC5D。用于获取运输 API 的 getShipment 操作的 RDT。针对特定运输。

/mfn/v0/shipments/{shipmentId}。用于获取运输 API 的 getShipment 操作的 RDT。针对您在调用 getShipment 操作时指定的任何销售合作伙伴的运输。

dataElements

array[string]

可选

指示请求的个人身份信息的类型。此参数仅在使用Orders API的getOrder、getOrders或getOrderItems操作获取RDT时需要。有关更多信息，请参阅Tokens API用例指南。可能的值包括：

buyerInfo。在订单级别，这包括买方的一般识别信息和税务相关信息。在订单项目级别，这包括礼品包装信息和自定义订单信息（如果可用）。

shippingAddress。这包括履行订单所需的信息。

buyerTaxInformation。这包括开具税务发票所需的信息。

示例

{
    "targetApplication": "string",
    "restrictedResources": [
        {
            "method": "GET",
            "path": "string",
            "dataElements": [
                "string"
            ]
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sellingpartnerapi-na.amazon.com/tokens/2021-03-01/restrictedDataToken' \
--header 'Content-Type: application/json' \
--data-raw '{
    "targetApplication": "string",
    "restrictedResources": [
        {
            "method": "GET",
            "path": "string",
            "dataElements": [
                "string"
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

您对此操作的速率限制（每秒请求数量）。

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

createRestrictedDataToken 操作的响应模式。

restrictedDataToken

string

可选

受限数据令牌（RDT）。这是一个短期有效的访问令牌，授权对受限操作的调用。在对这些受限资源进行后续调用时，请通过 x-amz-access-token 头传递此值。

expiresIn

integer

可选

受限数据令牌的有效期限，以秒为单位。

示例

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

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

getPaymentMethods

createUploadDestinationForResource