Notifications API v1 参考

亚马逊SPAPI

# 概述

销售伙伴通知的API让你可以订阅与销售伙伴的业务有关的通知.使用这个API,你可以创建一个目的地来接收通知,订阅通知,删除通知订阅,以及更多.

更多信息,请参阅Notifications Use Case Guide (opens new window).

# Version information

Version : v1

# Operations

getSubscription
createSubscription
getSubscriptionById
deleteSubscriptionById
getDestinations
createDestination
getDestination
deleteDestination
<a name="paths">

# 路径

<a name="getubscription">

# getSubscription

GET /notifications/v1/subscriptions/{notificationType}

# Description

返回指定通知类型的订阅信息.当你没有订阅标识符时,你可以使用这个API来获取订阅信息.

使用计划:

速率(每秒的请求) 突发
1 5

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Path notificationType
required
The type of notification.

关于通知类型的更多信息,请参阅the Notifications API Use Case Guide (opens new window).
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetSubscriptionResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetSubscriptionResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetSubscriptionResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetSubscriptionResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionResponse

<a name="createubscription">

# createSubscription

POST /notifications/v1/subscriptions/{notificationType}

# Description

为指定的通知类型创建一个订阅,以交付给指定的目的地.在订阅之前,你必须首先通过调用createDestination操作来创建目的地.

使用计划:

|速率(每秒的请求) |突发|_ | ---- | ---- | | 1 | 5 |

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Body body
required
the request schema for the createSubscription operation. CreateSubscriptionRequest
Path notificationType
required
通知的类型.

关于通知类型的更多信息,请参见the Notifications API Use Case Guide (opens new window).
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
CreateSubscriptionResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateSubscriptionResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
CreateSubscriptionResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
CreateSubscriptionResponse
409 指定的资源与当前状态冲突.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
CreateSubscriptionResponse
413 请求的大小超过了最大接受的大小.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
CreateSubscriptionResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
CreateSubscriptionResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateSubscriptionResponse
500 发生了一个意外情况,使服务器无法完成请求.
*头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
CreateSubscriptionResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateSubscriptionResponse

<a name="getsubscriptionbyid">

# getSubscriptionById

GET /notifications/v1/subscriptions/{notificationType}/{subscriptionId}

# Description

返回指定通知类型的订阅信息. getSubscriptionById API是无授权的. 更多信息,请参阅《销售伙伴API开发者指南》中的无授权操作 (opens new window).

使用计划:

|速率(每秒的请求) |突发| |率 | ---- | ---- | | 1 | 5 |

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Path subscriptionId
required
你想得到的订阅的标识符. string
Path notificationType
required
通知的类型.

关于通知类型的更多信息,请参见the Notifications API Use Case Guide (opens new window).
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetSubscriptionByIdResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetSubscriptionByIdResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
GetSubscriptionByIdResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetSubscriptionResponse
409 指定的资源与当前状态冲突.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionByIdResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionByIdResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionByIdResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionByIdResponse
500 发生了一个意外情况,使服务器无法完成该请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionByIdResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetSubscriptionByIdResponse

<a name="deletesubscriptionbyid">

# deleteSubscriptionById

DELETE /notifications/v1/subscriptions/{notificationType}/{subscriptionId}

# Description

删除由你指定的订阅标识符和通知类型所指示的订阅.订阅标识符可以是与你的应用程序相关的任何订阅.在你成功调用该操作后,将停止为相关的订阅发送通知. DeleteSubscriptionById API是无授权的.更多信息,请参见《销售伙伴API开发者指南》中的无授权操作 (opens new window).

使用计划:

|速率(每秒的请求) |突发| |率 | ---- | ---- | | 1 | 5 |

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Path subscriptionId
required
你想删除的订阅的标识符. string
Path notificationType
required
通知的类型.

关于通知类型的更多信息,请参见the Notifications API Use Case Guide (opens new window).
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
DeleteSubscriptionByIdResponse
400 Request有缺失或无效的参数,不能被解析.
头信息:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
DeleteSubscriptionByIdResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
DeleteSubscriptionByIdResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
DeleteSubscriptionByIdResponse
409 指定的资源与当前状态冲突.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
DeleteSubscriptionByIdResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
DeleteSubscriptionByIdResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
DeleteSubscriptionByIdResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
DeleteSubscriptionByIdResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
DeleteSubscriptionByIdResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
DeleteSubscriptionByIdResponse

<a name="getdestinations">

# getDestinations

GET /notifications/v1/destinations

# Description

返回所有目的地的信息. getDestinations API是无授权的. 更多信息,请参阅《销售伙伴API开发者指南》中的无授权操作 (opens new window).

使用计划:

|速率(每秒的请求) |突发| |率 | ---- | ---- | | 1 | 5 |

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetDestinationsResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetDestinationsResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetDestinationsResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetDestinationsResponse
409 指定的资源与当前状态冲突.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetDestinationsResponse
413 请求的大小超过了最大接受的大小.

x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetDestinationsResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetDestinationsResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetDestinationsResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetDestinationsResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetDestinationsResponse

<a name="createdestination">

# createDestination

POST /notifications/v1/destinations

# Description

创建一个目的地资源来接收通知. createDestination API是无授权的. 更多信息,请看无授权操作 (opens new window) 在Selling Partner API Developer Guide.

使用计划:

速率(每秒请求次数) 突发
1 5

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Body body
required
the request schema for createDestination operation. CreateDestinationRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
CreateDestinationResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDestinationResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateDestinationResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
CreateDestinationResponse
409 指定的资源与当前状态冲突.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateDestinationResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateDestinationResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateDestinationResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateDestinationResponse
500 发生了一个意外情况,使服务器无法完成请求.
*头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateDestinationResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态码,速率限制头已经废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateDestinationResponse

<a name="getdestination">

# getDestination

GET /notifications/v1/destinations/{destinationId}

# Description

返回您指定的目的地的信息. getDestination API是无授权的. 更多信息,请参阅《销售伙伴API开发者指南》中的无授权操作 (opens new window).

使用计划:

速率(每秒请求次数) 突发
1 5

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Path destinationId
required
您创建目的地时产生的标识符. string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetDestinationResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetDestinationResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetDestinationResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetDestinationResponse
409 指定的资源与当前状态冲突.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetDestinationResponse
413 请求的大小超过了最大接受的大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetDestinationResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetDestinationResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetDestinationResponse
500 发生了一个意想不到的情况,使服务器无法完成请求.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetDestinationResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetDestinationResponse

<a name="deleteestination">

# deleteDestination

DELETE /notifications/v1/destinations/{destinationId}

# Description

删除您指定的目的地. deleteDestination API是无授权的. 更多信息,请参见《销售伙伴API开发者指南》中的无授权操作 (opens new window).

使用计划:

速率(每秒请求次数) 突发
1 5

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Path destinationId
required
你要删除的目的地的标识符. string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : Unique request reference identifier.
DeleteDestinationResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
DeleteDestinationResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
DeleteDestinationResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
DeleteDestinationResponse
409 指定的资源与当前状态冲突.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
DeleteDestinationResponse
413 请求的大小超过了最大接受的大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
DeleteDestinationResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
DeleteDestinationResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
DeleteDestinationResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
DeleteDestinationResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态码,速率限制头已经废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
DeleteDestinationResponse

<a name="definitions">

# Definitions

<a name="processingdirective">

# ProcessingDirective

传递给订阅的额外信息,以控制通知的处理. 例如,你可以使用一个 eventFilter 来定制你的订阅,只为指定的 marketplaceId's 发送通知,或者选择发送通知的聚集时间段(e.g. 对于高频率的通知,限制为每五分钟一个通知). 可用的具体功能根据通知类型而不同.

该功能仅限于特定的notificationTypes,目前只支持ANY_OFFER_CHANGED通知类型.

Name Description Schema
eventFilter
optional
A notificationType specific filter. EventFilter

<a name="eventfilter">

# EventFilter

一个特定于通知类型的过滤器. 这个对象包含所有当前可用的过滤器和属性,你可以用它来定义一个特定于通知类型的过滤器.

多态性 : 组成

Name Description Schema
aggregationSettings
optional
A容器,持有所有必要的属性来配置通知的聚合. AggregationSettings
marketplaceIds
optional
A list of marketplace identifiers to subscribe to (e.g. ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list. MarketplaceIds
eventFilterType
required
一个特定通知类型所支持的eventFilterType值.这是订阅服务用来确定事件过滤器的类型.请参考Notifications Use Case Guide (opens new window)中描述特定通知类型的部分,以确定是否支持eventFilterType. string

<a name="marketplacefilter">

# MarketplaceFilter

使用这个事件过滤器来定制你的订阅,只为指定的marketplaceId的.发送通知

Name Description Schema
marketplaceIds
optional
A list of marketplace identifiers to subscribe to (e.g. ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list. MarketplaceIds

<a name="marketplaceids">

# MarketplaceIds

要订阅的市场标识符列表(e.g. ATVPDKIKX0DER). 要接收每个市场的通知,不要提供这个列表.

类型 : < string > array

<a name="aggregationfilter">

# AggregationFilter

使用这个过滤器来选择发送通知的聚集时间段(e.g.对于高频率的通知,限制为每5分钟一个通知).

Name Description Schema
aggregationSettings
optional
A容器,持有所有必要的属性来配置通知的聚合. AggregationSettings

<a name="aggregationsettings">

# AggregationSettings

一个容纳所有必要的属性的容器,用于配置通知的聚合.

Name Description Schema
aggregationTimePeriod
required
支持的时间段,用来进行市场-ASIN级别的聚合. AggregationTimePeriod

<a name="aggregationtimeperiod">

# AggregationTimePeriod

支持的聚合时间段. 例如,如果选择的是FiveMinutes,一个ASIN在5分钟内发生了50次价格更新,亚马逊将只发送两个通知;一个是第一个事件,然后是5分钟后的后续通知,包括数据的最终结束状态. 48个临时事件将被放弃.

类型 : 枚举

Value Description
五分钟 每隔五分钟就会发送一次汇总通知.
十分钟 每十分钟将发送一次汇总通知.

<a name="subscription">

# Subscription

代表一个接收通知的订阅.

Name Description Schema
subscriptionId
required
创建订阅时产生的订阅标识符. string
payloadVersion
required
通知中要使用的payload对象的版本. string
destinationId
required
将被交付通知的目的地的标识符. string
processingDirective
optional
传递给订阅的额外信息,以控制通知的处理. 例如,你可以使用eventFilter来定制你的订阅,只为指定的marketplaceId的发送通知或者选择发送通知的聚集时间段(e.g.对于高频率的通知,限制在每五分钟一个通知). 可用的具体功能根据通知类型的不同而不同notificationType.

这个功能只限于特定的notificationTypes,目前只支持ANY_OFFER_CHANGED通知类型.
ProcessingDirective

<a name="createubscriptionresponse">

# CreateSubscriptionResponse

createSubscription操作的响应模式.

Name Description Schema
payload
optional
createSubscription操作的有效载荷. Subscription
errors
optional
在createSubscription操作中发生了一个或多个意外的错误. ErrorList

<a name="createubscriptionrequest">

# CreateSubscriptionRequest

createSubscription操作的请求模式.

Name Description Schema
payloadVersion
optional
通知中使用的payload对象的版本. string
destinationId
optional
通知将被传送的目的地的标识符. string
processingDirective
optional
传递给订阅的额外信息,以控制通知的处理. 例如,你可以使用eventFilter来定制你的订阅,只为指定的marketplaceId的发送通知或者选择发送通知的聚集时间段(e.g.对于高频率的通知,限制在每五分钟一个通知). 可用的具体功能根据通知类型的不同而不同notificationType.

这个功能只限于特定的notificationTypes,目前只支持ANY_OFFER_CHANGED通知类型.
ProcessingDirective

<a name="getubscriptionbyidresponse">

# GetSubscriptionByIdResponse

getSubscriptionById操作的响应模式.

Name Description Schema
payload
optional
getSubscriptionById操作的有效载荷. Subscription
errors
optional
在getSubscriptionById操作中发生了一个意外情况. ErrorList

<a name="getsubscriptionresponse">

# GetSubscriptionResponse

getSubscription操作的响应模式.

Name Description Schema
payload
optional
getSubscription操作的有效载荷. Subscription
errors
optional
在 getSubscription 操作中发生了一个或多个意外的错误. ErrorList

<a name="deletesubscriptionbyidresponse">

# DeleteSubscriptionByIdResponse

deleteSubscriptionById操作的响应模式.

Name Description Schema
errors
optional
An unexpected condition occurred during the deleteSubscriptionById operation. ErrorList

<a name="destinationlist">

# DestinationList

一个目的地列表.

类型 < 目的地 > 数组

<a name="目的地">

# Destination

代表当你调用 createDestination 操作时创建的目的地.

Name Description Schema
name
required
The developer-defined name for this destination.
maxLength : 256
string
destinationId
required
当你创建目的地时产生的目的地标识符. string
resource
required
将接收与此目的地相关的通知的资源. DestinationResource

<a name="destinationresource">

# DestinationResource

目的资源类型.

Name Description Schema
sqs
optional
An Amazon Simple Queue Service (SQS) queue destination. SqsResource
eventBridge
optional
An Amazon EventBridge destination. EventBridgeResource

<a name="destinationresourcespecification">

# DestinationResourceSpecification

创建目的地资源所需的信息. 应用程序应在每个目的地使用一个资源类型(sqs或eventBridge)

Name Description Schema
sqs
optional
创建亚马逊简单队列服务(SQS)队列目的地. SqsResource
eventBridge
optional
创建Amazon EventBridge目的地所需的信息. EventBridgeResourceSpecification

<a name="sqsresource">

# SqsResource

创建亚马逊简单队列服务(亚马逊SQS)队列目的地.所需的信息

Name Description Schema
arn
required
与SQS队列相关的亚马逊资源名称(ARN).
maxLength : 1000
*Pattern : "^arn:aws:sqs:\\S+:\\S+:\\S+"
string

<a name="eventbridgeresourcespecification">

# EventBridgeResourceSpecification

创建Amazon EventBridge目的地所需的信息.

Name Description Schema
region
required
您将收到通知的AWS地区. string
accountId
required
负责接收通知相关费用的AWS账户的标识. string

<a name="eventbridgeresource">

# EventBridgeResource

代表Amazon EventBridge的一个目的地.

Name Description Schema
name
required
与目的地相关的伙伴事件源的名称.
maxLength : 256
string
region
required
接收通知的AWS区域.关于Amazon EventBridge支持的AWS区域,见https://docs.aws.amazon.com/general/latest/gr/ev.html. string
accountId
required
负责接收通知相关费用的AWS账户的标识符. string

<a name="createdestinationrequest">

# CreateDestinationRequest

createDestination操作的请求模式.

Name Description Schema
resourceSpecification
required
创建目的地资源所需的信息.应用程序应在每个目的地使用一种资源类型(sqs或eventBridge) DestinationResourceSpecification
name
required
A developer-defined name to help identify this destination. string

<a name="createdestinationresponse">

# CreateDestinationResponse

createDestination操作的响应模式.

Name Description Schema
payload
optional
createDestination操作的有效载荷. Destination
errors
optional
在createDestination操作中发生了一个或多个意外的错误. ErrorList

<a name="getdestinationresponse">

# GetDestinationResponse

getDestination操作的响应模式.

Name Description Schema
payload
optional
getDestination操作的有效载荷. Destination
errors
optional
在getDestination操作中发生了一个或多个意外的错误. ErrorList

<a name="getdestinationsresponse">

# GetDestinationsResponse

getDestinations操作的响应模式.

Name Description Schema
payload
optional
getDestinations操作的有效载荷. DestinationList
errors
optional
在getDestinations操作中发生了一个或多个意外的错误. ErrorList

<a name="deleteestinationresponse">

# DeleteDestinationResponse

deleteDestination操作的响应模式.

Name Description Schema
errors
optional
在deleteDestination操作中发生了一个或多个意外的错误. ErrorList

<a name="errorlist">

# ErrorList

当一个请求不成功时返回的错误响应列表.

类型 < Error > 数组

<a name="error">

# Error

当请求不成功时返回的错误响应.

Name Description Schema
code
required
一个错误代码,用于识别所发生的错误类型. string
message
required
一个以人类可读的形式描述错误情况的信息. string
details
optional
可以帮助呼叫者理解或解决这个问题的额外细节. string
Last Updated: 2022/10/17 下午9:17:02