チュートリアル:ORDER_CHANGE通知を購読する
ORDER_CHANGE
通知を購読するためのワークフロー
このチュートリアルでは、の使用方法について説明します ORDER_CHANGE
通知は、注文可能状況に変更があったときに送信されます。この通知を購読すると、注文処理の負荷が軽減され、Amazon Selling Partner APIとの統合のパフォーマンスが向上します。
のメリット ORDER_CHANGE
通知
ORDER_CHANGE
通知ザの ORDER_CHANGE
通知には以下の利点があります。
- その後のワークフローを自動化するのに十分な情報: これで、次のものを使用できます。
ORDER_CHANGE
注文に関する情報を取得するためのペイロード。この通知は、購入者がキャンセルをリクエストした場合に通知されるようにも設計されています。 - 必要に応じて通知を受けるイベント: Orders API をポーリングし続ける必要がなくなり、サーバーの容量を節約できます。
- 注文レベルでの統合ペイロード: 注文に複数の注文アイテムがある場合、注文レベルで統合されたペイロードを受け取ります。注文レベルでトリガーすることで、より効率的な統合ワークフローを作成できます。
- イベントフィルターを使うと、サブスクリプションをフィルターできます。 イベントフィルターがでサポートされるようになりました
ORDER_CHANGE
通知。イベントフィルターを使用すると、関連するイベントを登録できますOrderChangeType
ビジネスに関連する注文通知をフィルタリングします。現在、購入者がリクエストしたキャンセルと注文状況の変更をサポートしています。 - 今後の用途に合わせて拡張可能なイベントフィルター: この新しい通知により、Amazonは今後注文に関連するイベント (特定のEasy Shipイベントやカーブサイド集荷イベントなど) を追加できるようになります。
- リアルタイムのイベント変更を提供するために変更時刻が追加されました: ザ・
ORDER_CHANGE
通知には、注文変更時刻がペイロードのフィールドとして含まれています。これをインテグレーションに実装することで、販売者にリアルタイムで最新情報を提供できます。
チュートリアル
次のチュートリアルは、サブスクライブして使用するのに役立ちます ORDER_CHANGE
通知。
前提条件
Before you subscribe to the ORDER_CHANGE
notification, your developer profile and app must have the Inventory and Order Tracking role or Amazon Fulfillment role assigned.
重要:
この通知の以前のバージョンは、
ORDER_STATUS_CHANGE
、は廃止されました。を購読してくださいORDER_CHANGE
への通知と購読の削除ORDER_STATUS_CHANGE
。
- Call the
getSubscription
operation to fetch thesubscriptionId
ofORDER_STATUS_CHANGE
.- With the
subscriptionId
, use thedeleteSubscriptionById
operation to delete the subscription to theORDER_STATUS_CHANGE
notification. Remember that thedeleteSubscriptionById
operation is a grantless operation.
ステップ 1:を購読する ORDER_CHANGE
通知
ORDER_CHANGE
通知- サブスクリプションを作成して
ORDER_CHANGE
処理ディレクティブを使用する。
The processingDirective
is used to pass additional information to the subscription to control the processing of notifications. For example, you can use eventFilter
to filter out notifications for a specific Order Change Type.
To use eventFilter
for ORDER_CHANGE
notifications, make sure to include eventFilterType
and orderChangeTypes
in the create subscription step.
-
Call the
createSubscription
operation. -
Add the parameter
ORDER_CHANGE
in thenotificationType
path variable.
The following payload shows how to set a filter to receive only notifications about order status changes. Make sure to include your destinationId
:
POST https://sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/ORDER_CHANGE
{
"payloadVersion": "1.0",
"destinationId": "e22gf420-1606-47c4-a393-91df6648d3da",
"processingDirective": {
"eventFilter": {
"orderChangeTypes": [
"OrderStatusChange"
],
"eventFilterType": "ORDER_CHANGE"
}
}
}
リクエストが成功すると、次の応答が返されます。
{
"payload": {
"subscriptionId": "92d519e4-f208-493b-9092-d70cf546c383",
"destinationId": "e22gf420-1606-47c4-a393-91df6648d3da",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"orderChangeTypes": [
"OrderStatusChange"
],
"eventFilterType": "ORDER_CHANGE"
}
}
}
}
受け取りたい場合 BuyerRequestedChange
情報、必ず含めてください BuyerRequestedChange
に orderChangeTypes
関連する通知を除外します。すべての注文変更タイプからの注文通知を受け取るには、以下を追加してください eventFilterType
この通知を購読するときの設定。
サンプルペイロード:
{
"destinationId": "e22gf420-1606-47c4-a393-91df6648d3da",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"eventFilterType": "ORDER_CHANGE"
}
}
}
ステップ 2:通知メッセージを受信する
通知が正しく設定されると、すべての注文ステータスの変更に関するメッセージが Amazon シンプルキューサービス (Amazon SQS) キューに届きます。
以下は、の例です ORDER_CHANGE
通知:
{
"NotificationVersion" : "1.0",
"NotificationType" : "ORDER_CHANGE",
"PayloadVersion" : "1.0",
"EventTime" : "2023-10-03T01:35:06.382Z",
"Payload" : {
"OrderChangeNotification" : {
"NotificationLevel" : "OrderLevel",
"SellerId" : "ABCDEFGFMDKELDW",
"AmazonOrderId" : "123-4567891-4567891",
"OrderChangeType" : "OrderStatusChange",
"OrderChangeTrigger" : {
"TimeOfOrderChange" : "2023-10-03T01:35:01.000Z",
"ChangeReason" : "Order Status Change"
},
"Summary" : {
"MarketplaceId" : "A2Q3Y263D00KWC",
"OrderStatus" : "Unshipped",
"PurchaseDate" : "2023-10-03T01:03:44.106Z",
"DestinationPostalCode" : null,
"FulfillmentType" : "MFN",
"OrderType" : "StandardOrder",
"OrderPrograms" : [ ],
"ShippingPrograms" : [ ],
"OrderItems" : [ {
"OrderItemId" : "12345207241",
"SellerSKU" : "SKU123",
"SupplySourceId" : null,
"Quantity" : 15
} ]
}
}
},
"NotificationMetadata" : {
"ApplicationId" : "amzn1.sp.solution.c4d.......",
"SubscriptionId" : "52ac10........",
"PublishTime" : "2023-10-03T01:35:07.931Z",
"NotificationId" : "e9b0f384........"
}
}
When you receive a notification, check the value of OrderChangeTypes
in the notification payload:
BuyerRequestedChange
: The buyer has initiated a cancellation. To cancel an MFN order, use thePOST_ORDER_ACKNOWLEDGEMENT_DATA
feed.OrderStatusChange
: The order status has changed. Check the changedOrderStatus
. If it isUnshipped
, you can now start preparing your order to fulfill the items purchased by buyers. This is a time sensitive task; being notified in real-time helps you fulfill orders in a timely manner. After shipping the product to the customer, you are also expected to confirm the shipment to Amazon, notifying the buyer that the product is out for delivery. Refer to How to confirm MFN Orders using SP-API for more information on confirming MFN orders using Selling Partner APIs.
のペイロード ORDER_CHANGE
通知が提供されるようになりました OrderItems
関連する注文から。を使用するとき OrderItems
情報、もう電話する必要はありません getOrderItems
注文に含まれるアイテムを確認する操作。
結論
このチュートリアルでは、を購読して使用する方法について説明しました ORDER_CHANGE
通知。これにより、注文処理の負荷が軽減され、Amazon 販売パートナー API との統合のパフォーマンスが向上します。
Updated 8 months ago