From 3a799fdb5b902707d474f519088c11127d60f6ff Mon Sep 17 00:00:00 2001 From: Gibran Waldron Date: Wed, 20 Mar 2024 11:03:55 -0700 Subject: [PATCH] Update Feed_Processing_Finished and Report_Processing_Finished notification schemas. --- .../FeedProcessingFinishedNotification.json | 81 +++++++++++++++---- .../ReportProcessingFinishedNotification.json | 81 +++++++++++++++---- 2 files changed, 130 insertions(+), 32 deletions(-) diff --git a/schemas/notifications/FeedProcessingFinishedNotification.json b/schemas/notifications/FeedProcessingFinishedNotification.json index 9055c5c..1925c5a 100644 --- a/schemas/notifications/FeedProcessingFinishedNotification.json +++ b/schemas/notifications/FeedProcessingFinishedNotification.json @@ -12,6 +12,28 @@ "payload": { "feedProcessingFinishedNotification": { "sellerId": "A3TH9S8BH6GOGM", + "accountId": "amzn1.merchant.o.A3TH9S8BH6GOGM", + "feedId": "53347018456", + "feedType": "POST_PRODUCT_DATA", + "processingStatus": "DONE", + "resultFeedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ" + } + }, + "notificationMetadata": { + "applicationId": "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746", + "subscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746", + "publishTime": "2020-07-13T19:42:04.284Z", + "notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746" + } + }, + { + "notificationVersion": "2020-09-04", + "notificationType": "FEED_PROCESSING_FINISHED", + "payloadVersion": "2020-09-04", + "eventTime": "2020-07-13T19:42:04.284Z", + "payload": { + "feedProcessingFinishedNotification": { + "accountId": "amzn1.vg.6213651", "feedId": "53347018456", "feedType": "POST_PRODUCT_DATA", "processingStatus": "DONE", @@ -38,7 +60,7 @@ "notificationVersion": { "$id": "#/properties/notificationVersion", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The version of the notification.", "examples": [ "2020-09-04" ] @@ -46,7 +68,7 @@ "notificationType": { "$id": "#/properties/notificationType", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The type of the notification.", "examples": [ "FEED_PROCESSING_FINISHED" ] @@ -54,7 +76,7 @@ "payloadVersion": { "$id": "#/properties/payloadVersion", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The version of the payload.", "examples": [ "2020-09-04" ] @@ -62,7 +84,7 @@ "eventTime": { "$id": "#/properties/eventTime", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The timestamp of the event, formatted as ISO 8601 date-time.", "examples": [ "2020-07-13T19:42:04.284Z" ] @@ -70,11 +92,21 @@ "payload": { "$id": "#/properties/payload", "type": "object", - "description": "An explanation about the purpose of this instance.", + "description": "The details of this notification.", "examples": [ { "feedProcessingFinishedNotification": { "sellerId": "A3TH9S8BH6GOGM", + "accountId": "amzn1.merchant.o.A3TH9S8BH6GOGM", + "feedId": "53347018456", + "feedType": "POST_PRODUCT_DATA", + "processingStatus": "DONE", + "resultFeedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ" + } + }, + { + "feedProcessingFinishedNotification": { + "accountId": "amzn1.vg.6213651", "feedId": "53347018456", "feedType": "POST_PRODUCT_DATA", "processingStatus": "DONE", @@ -93,6 +125,14 @@ "examples": [ { "sellerId": "A3TH9S8BH6GOGM", + "accountId": "amzn1.merchant.o.A3TH9S8BH6GOGM", + "feedId": "53347018456", + "feedType": "POST_PRODUCT_DATA", + "processingStatus": "DONE", + "resultFeedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ" + }, + { + "accountId": "amzn1.vg.6213651", "feedId": "53347018456", "feedType": "POST_PRODUCT_DATA", "processingStatus": "DONE", @@ -100,7 +140,7 @@ } ], "required": [ - "sellerId", + "accountId", "feedId", "feedType", "processingStatus" @@ -109,15 +149,24 @@ "sellerId": { "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/sellerId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The merchant customer identifier of the selling partner account on whose behalf the feed was submitted. This field will be null when the feed was submitted on behalf of a vendor group identifier.", "examples": [ "A3TH9S8BH6GOGM" ] }, + "accountId": { + "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/accountId", + "type": "string", + "description": "The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the feed was submitted.", + "examples": [ + "amzn1.merchant.o.A3TH9S8BH6GOGM", + "amzn1.vg.6213651" + ] + }, "feedId": { "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The feed identifier.", "examples": [ "53347018456" ] @@ -125,7 +174,7 @@ "feedType": { "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedType", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The feed type.", "examples": [ "POST_PRODUCT_DATA" ] @@ -133,7 +182,7 @@ "processingStatus": { "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/processingStatus", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The processing status of the feed.", "examples": [ "CANCELLED", "DONE", @@ -148,7 +197,7 @@ "resultFeedDocumentId": { "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/resultFeedDocumentId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The feed document identifier. This identifier is unique only in combination with a seller ID.", "examples": [ "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ" ] @@ -160,7 +209,7 @@ "notificationMetadata": { "$id": "#/properties/notificationMetadata", "type": "object", - "description": "An explanation about the purpose of this instance.", + "description": "The metadata of the notification.", "examples": [ { "applicationId": "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746", @@ -179,7 +228,7 @@ "applicationId": { "$id": "#/properties/notificationMetadata/properties/applicationId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The application identifier.", "examples": [ "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746" ] @@ -187,7 +236,7 @@ "subscriptionId": { "$id": "#/properties/notificationMetadata/properties/subscriptionId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The subscription identifier.", "examples": [ "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746" ] @@ -195,7 +244,7 @@ "publishTime": { "$id": "#/properties/notificationMetadata/properties/publishTime", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The timestamp of when the notification was published, formatted as ISO 8601 date-time.", "examples": [ "2020-07-13T19:42:04.284Z" ] @@ -203,7 +252,7 @@ "notificationId": { "$id": "#/properties/notificationMetadata/properties/notificationId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The notification identifier.", "examples": [ "d0e9e693-c3ad-4373-979f-ed4ec98dd746" ] diff --git a/schemas/notifications/ReportProcessingFinishedNotification.json b/schemas/notifications/ReportProcessingFinishedNotification.json index a104dab..8a2246c 100644 --- a/schemas/notifications/ReportProcessingFinishedNotification.json +++ b/schemas/notifications/ReportProcessingFinishedNotification.json @@ -12,6 +12,28 @@ "payload": { "reportProcessingFinishedNotification": { "sellerId": "A3TH9S8BH6GOGM", + "accountId": "amzn1.merchant.o.A3TH9S8BH6GOGM", + "reportId": "54517018502", + "reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA", + "processingStatus": "CANCELLED", + "reportDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ" + } + }, + "notificationMetadata": { + "applicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336", + "subscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746", + "publishTime": "2020-07-13T19:42:04.284Z", + "notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746" + } + }, + { + "notificationVersion": "2020-09-04", + "notificationType": "REPORT_PROCESSING_FINISHED", + "payloadVersion": "2020-09-04", + "eventTime": "2020-07-14T03:35:13.214Z", + "payload": { + "reportProcessingFinishedNotification": { + "accountId": "amzn1.vg.6213651", "reportId": "54517018502", "reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA", "processingStatus": "CANCELLED", @@ -38,7 +60,7 @@ "notificationVersion": { "$id": "#/properties/notificationVersion", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The version of the notification.", "examples": [ "2020-09-04" ] @@ -46,7 +68,7 @@ "notificationType": { "$id": "#/properties/notificationType", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The type of the notification.", "examples": [ "REPORT_PROCESSING_FINISHED" ] @@ -54,7 +76,7 @@ "payloadVersion": { "$id": "#/properties/payloadVersion", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The version of the payload.", "examples": [ "2020-09-04" ] @@ -62,7 +84,7 @@ "eventTime": { "$id": "#/properties/eventTime", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The timestamp of the event, formatted as ISO 8601 date-time.", "examples": [ "2020-07-14T03:35:13.214Z" ] @@ -70,11 +92,21 @@ "payload": { "$id": "#/properties/payload", "type": "object", - "description": "An explanation about the purpose of this instance.", + "description": "The details of this notification.", "examples": [ { "reportProcessingFinishedNotification": { "sellerId": "A3TH9S8BH6GOGM", + "accountId": "amzn1.merchant.o.A3TH9S8BH6GOGM", + "reportId": "54517018502", + "reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA", + "processingStatus": "CANCELLED", + "reportDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ" + } + }, + { + "reportProcessingFinishedNotification": { + "accountId": "amzn1.vg.6213651", "reportId": "54517018502", "reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA", "processingStatus": "CANCELLED", @@ -93,6 +125,14 @@ "examples": [ { "sellerId": "A3TH9S8BH6GOGM", + "accountId": "amzn1.merchant.o.A3TH9S8BH6GOGM", + "reportId": "54517018502", + "reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA", + "processingStatus": "CANCELLED", + "reportDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ" + }, + { + "accountId": "amzn1.vg.6213651", "reportId": "54517018502", "reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA", "processingStatus": "CANCELLED", @@ -100,7 +140,7 @@ } ], "required": [ - "sellerId", + "accountId", "reportId", "reportType", "processingStatus" @@ -109,15 +149,24 @@ "sellerId": { "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/sellerId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The merchant customer identifier of the selling partner account on whose behalf the report was submitted. This field will be null when the report was submitted on behalf of a vendor group identifier.", "examples": [ "A3TH9S8BH6GOGM" ] }, + "accountId": { + "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/accountId", + "type": "string", + "description": "The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the report was submitted.", + "examples": [ + "amzn1.merchant.o.A3TH9S8BH6GOGM", + "amzn1.vg.6213651" + ] + }, "reportId": { "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The report identifier.", "examples": [ "54517018502" ] @@ -125,7 +174,7 @@ "reportType": { "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportType", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The report type.", "examples": [ "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA" ] @@ -133,7 +182,7 @@ "processingStatus": { "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/processingStatus", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The processing status of the report.", "examples": [ "CANCELLED", "DONE", @@ -148,7 +197,7 @@ "reportDocumentId": { "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportDocumentId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The report document identifier. This identifier is unique only in combination with a seller ID.", "examples": [ "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ" ] @@ -160,7 +209,7 @@ "notificationMetadata": { "$id": "#/properties/notificationMetadata", "type": "object", - "description": "An explanation about the purpose of this instance.", + "description": "The metadata of the notification.", "examples": [ { "applicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336", @@ -179,7 +228,7 @@ "applicationId": { "$id": "#/properties/notificationMetadata/properties/applicationId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The application identifier.", "examples": [ "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336" ] @@ -187,7 +236,7 @@ "subscriptionId": { "$id": "#/properties/notificationMetadata/properties/subscriptionId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The subscription identifier.", "examples": [ "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746" ] @@ -195,7 +244,7 @@ "publishTime": { "$id": "#/properties/notificationMetadata/properties/publishTime", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The timestamp of when the notification was published, formatted as ISO 8601 date-time.", "examples": [ "2020-07-13T19:42:04.284Z" ] @@ -203,7 +252,7 @@ "notificationId": { "$id": "#/properties/notificationMetadata/properties/notificationId", "type": "string", - "description": "An explanation about the purpose of this instance.", + "description": "The notification identifier.", "examples": [ "d0e9e693-c3ad-4373-979f-ed4ec98dd746" ]