wezone
/
selling-partner-api-models
mirror of https://github.com/amzn/selling-partner-api-models.git
10
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update Feed_Processing_Finished and Report_Processing_Finished notification schemas.

This commit is contained in:
Gibran Waldron 2024-03-20 11:03:55 -07:00
parent 7bde415568
commit 3a799fdb5b
2 changed files with 130 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
schemas/notifications/FeedProcessingFinishedNotification.json
View File

@ -12,6 +12,28 @@
"payload": { "payload": {
"feedProcessingFinishedNotification": { "feedProcessingFinishedNotification": {
"sellerId": "A3TH9S8BH6GOGM", "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", "feedId": "53347018456",
"feedType": "POST_PRODUCT_DATA", "feedType": "POST_PRODUCT_DATA",
"processingStatus": "DONE", "processingStatus": "DONE",
@ -38,7 +60,7 @@
"notificationVersion": { "notificationVersion": {
"$id": "#/properties/notificationVersion", "$id": "#/properties/notificationVersion",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The version of the notification.",
"examples": [ "examples": [
"2020-09-04" "2020-09-04"
] ]
@ -46,7 +68,7 @@
"notificationType": { "notificationType": {
"$id": "#/properties/notificationType", "$id": "#/properties/notificationType",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The type of the notification.",
"examples": [ "examples": [
"FEED_PROCESSING_FINISHED" "FEED_PROCESSING_FINISHED"
] ]
@ -54,7 +76,7 @@
"payloadVersion": { "payloadVersion": {
"$id": "#/properties/payloadVersion", "$id": "#/properties/payloadVersion",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The version of the payload.",
"examples": [ "examples": [
"2020-09-04" "2020-09-04"
] ]
@ -62,7 +84,7 @@
"eventTime": { "eventTime": {
"$id": "#/properties/eventTime", "$id": "#/properties/eventTime",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The timestamp of the event, formatted as ISO 8601 date-time.",
"examples": [ "examples": [
"2020-07-13T19:42:04.284Z" "2020-07-13T19:42:04.284Z"
] ]
@ -70,11 +92,21 @@
"payload": { "payload": {
"$id": "#/properties/payload", "$id": "#/properties/payload",
"type": "object", "type": "object",
"description": "An explanation about the purpose of this instance.", "description": "The details of this notification.",
"examples": [ "examples": [
{ {
"feedProcessingFinishedNotification": { "feedProcessingFinishedNotification": {
"sellerId": "A3TH9S8BH6GOGM", "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", "feedId": "53347018456",
"feedType": "POST_PRODUCT_DATA", "feedType": "POST_PRODUCT_DATA",
"processingStatus": "DONE", "processingStatus": "DONE",
@ -93,6 +125,14 @@
"examples": [ "examples": [
{ {
"sellerId": "A3TH9S8BH6GOGM", "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", "feedId": "53347018456",
"feedType": "POST_PRODUCT_DATA", "feedType": "POST_PRODUCT_DATA",
"processingStatus": "DONE", "processingStatus": "DONE",
@ -100,7 +140,7 @@
} }
], ],
"required": [ "required": [
"sellerId", "accountId",
"feedId", "feedId",
"feedType", "feedType",
"processingStatus" "processingStatus"
@ -109,15 +149,24 @@
"sellerId": { "sellerId": {
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/sellerId", "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/sellerId",
"type": "string", "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": [ "examples": [
"A3TH9S8BH6GOGM" "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": { "feedId": {
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedId", "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedId",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The feed identifier.",
"examples": [ "examples": [
"53347018456" "53347018456"
] ]
@ -125,7 +174,7 @@
"feedType": { "feedType": {
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedType", "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedType",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The feed type.",
"examples": [ "examples": [
"POST_PRODUCT_DATA" "POST_PRODUCT_DATA"
] ]
@ -133,7 +182,7 @@
"processingStatus": { "processingStatus": {
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/processingStatus", "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/processingStatus",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The processing status of the feed.",
"examples": [ "examples": [
"CANCELLED", "CANCELLED",
"DONE", "DONE",
@ -148,7 +197,7 @@
"resultFeedDocumentId": { "resultFeedDocumentId": {
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/resultFeedDocumentId", "$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/resultFeedDocumentId",
"type": "string", "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": [ "examples": [
"amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ" "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"
] ]
@ -160,7 +209,7 @@
"notificationMetadata": { "notificationMetadata": {
"$id": "#/properties/notificationMetadata", "$id": "#/properties/notificationMetadata",
"type": "object", "type": "object",
"description": "An explanation about the purpose of this instance.", "description": "The metadata of the notification.",
"examples": [ "examples": [
{ {
"applicationId": "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746", "applicationId": "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746",
@ -179,7 +228,7 @@
"applicationId": { "applicationId": {
"$id": "#/properties/notificationMetadata/properties/applicationId", "$id": "#/properties/notificationMetadata/properties/applicationId",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The application identifier.",
"examples": [ "examples": [
"amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746" "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746"
] ]
@ -187,7 +236,7 @@
"subscriptionId": { "subscriptionId": {
"$id": "#/properties/notificationMetadata/properties/subscriptionId", "$id": "#/properties/notificationMetadata/properties/subscriptionId",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The subscription identifier.",
"examples": [ "examples": [
"subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746" "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
] ]
@ -195,7 +244,7 @@
"publishTime": { "publishTime": {
"$id": "#/properties/notificationMetadata/properties/publishTime", "$id": "#/properties/notificationMetadata/properties/publishTime",
"type": "string", "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": [ "examples": [
"2020-07-13T19:42:04.284Z" "2020-07-13T19:42:04.284Z"
] ]
@ -203,7 +252,7 @@
"notificationId": { "notificationId": {
"$id": "#/properties/notificationMetadata/properties/notificationId", "$id": "#/properties/notificationMetadata/properties/notificationId",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The notification identifier.",
"examples": [ "examples": [
"d0e9e693-c3ad-4373-979f-ed4ec98dd746" "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
] ]

81
schemas/notifications/ReportProcessingFinishedNotification.json
View File

@ -12,6 +12,28 @@
"payload": { "payload": {
"reportProcessingFinishedNotification": { "reportProcessingFinishedNotification": {
"sellerId": "A3TH9S8BH6GOGM", "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", "reportId": "54517018502",
"reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA", "reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA",
"processingStatus": "CANCELLED", "processingStatus": "CANCELLED",
@ -38,7 +60,7 @@
"notificationVersion": { "notificationVersion": {
"$id": "#/properties/notificationVersion", "$id": "#/properties/notificationVersion",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The version of the notification.",
"examples": [ "examples": [
"2020-09-04" "2020-09-04"
] ]
@ -46,7 +68,7 @@
"notificationType": { "notificationType": {
"$id": "#/properties/notificationType", "$id": "#/properties/notificationType",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The type of the notification.",
"examples": [ "examples": [
"REPORT_PROCESSING_FINISHED" "REPORT_PROCESSING_FINISHED"
] ]
@ -54,7 +76,7 @@
"payloadVersion": { "payloadVersion": {
"$id": "#/properties/payloadVersion", "$id": "#/properties/payloadVersion",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The version of the payload.",
"examples": [ "examples": [
"2020-09-04" "2020-09-04"
] ]
@ -62,7 +84,7 @@
"eventTime": { "eventTime": {
"$id": "#/properties/eventTime", "$id": "#/properties/eventTime",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The timestamp of the event, formatted as ISO 8601 date-time.",
"examples": [ "examples": [
"2020-07-14T03:35:13.214Z" "2020-07-14T03:35:13.214Z"
] ]
@ -70,11 +92,21 @@
"payload": { "payload": {
"$id": "#/properties/payload", "$id": "#/properties/payload",
"type": "object", "type": "object",
"description": "An explanation about the purpose of this instance.", "description": "The details of this notification.",
"examples": [ "examples": [
{ {
"reportProcessingFinishedNotification": { "reportProcessingFinishedNotification": {
"sellerId": "A3TH9S8BH6GOGM", "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", "reportId": "54517018502",
"reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA", "reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA",
"processingStatus": "CANCELLED", "processingStatus": "CANCELLED",
@ -93,6 +125,14 @@
"examples": [ "examples": [
{ {
"sellerId": "A3TH9S8BH6GOGM", "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", "reportId": "54517018502",
"reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA", "reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA",
"processingStatus": "CANCELLED", "processingStatus": "CANCELLED",
@ -100,7 +140,7 @@
} }
], ],
"required": [ "required": [
"sellerId", "accountId",
"reportId", "reportId",
"reportType", "reportType",
"processingStatus" "processingStatus"
@ -109,15 +149,24 @@
"sellerId": { "sellerId": {
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/sellerId", "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/sellerId",
"type": "string", "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": [ "examples": [
"A3TH9S8BH6GOGM" "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": { "reportId": {
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportId", "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportId",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The report identifier.",
"examples": [ "examples": [
"54517018502" "54517018502"
] ]
@ -125,7 +174,7 @@
"reportType": { "reportType": {
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportType", "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportType",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The report type.",
"examples": [ "examples": [
"GET_FLAT_FILE_ACTIONABLE_ORDER_DATA" "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"
] ]
@ -133,7 +182,7 @@
"processingStatus": { "processingStatus": {
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/processingStatus", "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/processingStatus",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The processing status of the report.",
"examples": [ "examples": [
"CANCELLED", "CANCELLED",
"DONE", "DONE",
@ -148,7 +197,7 @@
"reportDocumentId": { "reportDocumentId": {
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportDocumentId", "$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportDocumentId",
"type": "string", "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": [ "examples": [
"amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ" "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"
] ]
@ -160,7 +209,7 @@
"notificationMetadata": { "notificationMetadata": {
"$id": "#/properties/notificationMetadata", "$id": "#/properties/notificationMetadata",
"type": "object", "type": "object",
"description": "An explanation about the purpose of this instance.", "description": "The metadata of the notification.",
"examples": [ "examples": [
{ {
"applicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336", "applicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
@ -179,7 +228,7 @@
"applicationId": { "applicationId": {
"$id": "#/properties/notificationMetadata/properties/applicationId", "$id": "#/properties/notificationMetadata/properties/applicationId",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The application identifier.",
"examples": [ "examples": [
"amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336" "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"
] ]
@ -187,7 +236,7 @@
"subscriptionId": { "subscriptionId": {
"$id": "#/properties/notificationMetadata/properties/subscriptionId", "$id": "#/properties/notificationMetadata/properties/subscriptionId",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The subscription identifier.",
"examples": [ "examples": [
"subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746" "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
] ]
@ -195,7 +244,7 @@
"publishTime": { "publishTime": {
"$id": "#/properties/notificationMetadata/properties/publishTime", "$id": "#/properties/notificationMetadata/properties/publishTime",
"type": "string", "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": [ "examples": [
"2020-07-13T19:42:04.284Z" "2020-07-13T19:42:04.284Z"
] ]
@ -203,7 +252,7 @@
"notificationId": { "notificationId": {
"$id": "#/properties/notificationMetadata/properties/notificationId", "$id": "#/properties/notificationMetadata/properties/notificationId",
"type": "string", "type": "string",
"description": "An explanation about the purpose of this instance.", "description": "The notification identifier.",
"examples": [ "examples": [
"d0e9e693-c3ad-4373-979f-ed4ec98dd746" "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
] ]