Add notification schemas
This commit is contained in:
Gibran Waldron
parent
8bbea90b14
commit
7127fcf2a1
|
|
@ -5,6 +5,8 @@ The [models directory](https://github.com/amzn/selling-partner-api-models/tree/m
|
|||
|
||||
The [clients directory](https://github.com/amzn/selling-partner-api-models/tree/main/clients) contains a [Java library](https://github.com/amzn/selling-partner-api-models/tree/main/clients/sellingpartner-api-aa-java) and a [C# library](https://github.com/amzn/selling-partner-api-models/tree/main/clients/sellingpartner-api-aa-csharp) with mustache templates for use with [swagger-codegen](https://swagger.io/tools/swagger-codegen/) to generate client libraries with authentication and authorization functionality included. The templates are located in *resources/swagger-codegen*.
|
||||
|
||||
The [schemas directory](https://github.com/amzn/selling-partner-api-models/tree/main/schemas) contains all of the currently available Selling Partner Api schemas.
|
||||
|
||||
## Security
|
||||
|
||||
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
|
||||
|
|
@ -12,3 +14,4 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform
|
|||
## License
|
||||
|
||||
This project is licensed under the Apache-2.0 License.
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,249 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "http://example.com/example.json",
|
||||
"type": "object",
|
||||
"title": "The root schema",
|
||||
"description": "The root schema comprises the entire JSON document.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"NotificationVersion": "1.0",
|
||||
"NotificationType": "BRANDED_ITEM_CONTENT_CHANGE",
|
||||
"PayloadVersion": "1.0",
|
||||
"EventTime": "2019-03-20T18:59:30.194Z",
|
||||
"Payload": {
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"BrandName": "Great Brand",
|
||||
"Asin": "B1234567",
|
||||
"AttributesChanged": [
|
||||
"bullet_point",
|
||||
"item_name",
|
||||
"product_description",
|
||||
"main_product_image_locator",
|
||||
"other_product_image_locator_1",
|
||||
"other_product_image_locator_2",
|
||||
"other_product_image_locator_3",
|
||||
"other_product_image_locator_4",
|
||||
"other_product_image_locator_5",
|
||||
"other_product_image_locator_6",
|
||||
"other_product_image_locator_7",
|
||||
"other_product_image_locator_8",
|
||||
"swatch_product_image_locator"
|
||||
]
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
|
||||
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime": "2019-03-20T18:59:48.768Z",
|
||||
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"NotificationVersion",
|
||||
"NotificationType",
|
||||
"PayloadVersion",
|
||||
"EventTime",
|
||||
"Payload",
|
||||
"NotificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"NotificationVersion": {
|
||||
"$id": "#/properties/NotificationVersion",
|
||||
"type": "string",
|
||||
"title": "The NotificationVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"NotificationType": {
|
||||
"$id": "#/properties/NotificationType",
|
||||
"type": "string",
|
||||
"title": "The NotificationType schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"BRANDED_ITEM_CONTENT_CHANGE"
|
||||
]
|
||||
},
|
||||
"PayloadVersion": {
|
||||
"$id": "#/properties/PayloadVersion",
|
||||
"type": "string",
|
||||
"title": "The PayloadVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"EventTime": {
|
||||
"$id": "#/properties/EventTime",
|
||||
"type": "string",
|
||||
"title": "The EventTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:30.194Z"
|
||||
]
|
||||
},
|
||||
"Payload": {
|
||||
"$id": "#/properties/Payload",
|
||||
"type": "object",
|
||||
"title": "The Payload schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"BrandName": "Great Brand",
|
||||
"Asin": "B1234567",
|
||||
"AttributesChanged": [
|
||||
"bullet_point",
|
||||
"item_name",
|
||||
"product_description",
|
||||
"main_product_image_locator",
|
||||
"other_product_image_locator_1",
|
||||
"other_product_image_locator_2",
|
||||
"other_product_image_locator_3",
|
||||
"other_product_image_locator_4",
|
||||
"other_product_image_locator_5",
|
||||
"other_product_image_locator_6",
|
||||
"other_product_image_locator_7",
|
||||
"other_product_image_locator_8",
|
||||
"swatch_product_image_locator"
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"MarketplaceId",
|
||||
"BrandName",
|
||||
"Asin",
|
||||
"AttributesChanged"
|
||||
],
|
||||
"properties": {
|
||||
"MarketplaceId": {
|
||||
"$id": "#/properties/Payload/properties/MarketplaceId",
|
||||
"type": "string",
|
||||
"title": "The MarketplaceId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"BrandName": {
|
||||
"$id": "#/properties/Payload/properties/BrandName",
|
||||
"type": "string",
|
||||
"title": "The BrandName schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"Great Brand"
|
||||
]
|
||||
},
|
||||
"Asin": {
|
||||
"$id": "#/properties/Payload/properties/Asin",
|
||||
"type": "string",
|
||||
"title": "The Asin schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"B1234567"
|
||||
]
|
||||
},
|
||||
"AttributesChanged": {
|
||||
"$id": "#/properties/Payload/properties/AttributesChanged",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"title": "Changed item attributes",
|
||||
"description": "The array of item attributes which changed. Possible values include bullet_point, item_name, product_description, and image-related attributes shown in the examples. NOTE: the attributes that contain the word 'image' all mean the same thing right now, which is that one or more images changed on the product detail page. In a future release we may update them to mean that individual image attribute changed, but for now if any image changes all the image attributes will be present in the notification. Attribute names, descriptions, and requirements are available in the Product Type Definitions API.",
|
||||
"examples": [
|
||||
["bullet_point", "item_name", "product_description"],
|
||||
[
|
||||
"main_product_image_locator",
|
||||
"other_product_image_locator_1",
|
||||
"other_product_image_locator_2",
|
||||
"other_product_image_locator_3",
|
||||
"other_product_image_locator_4",
|
||||
"other_product_image_locator_5",
|
||||
"other_product_image_locator_6",
|
||||
"other_product_image_locator_7",
|
||||
"other_product_image_locator_8",
|
||||
"swatch_product_image_locator"
|
||||
]
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"$id": "#/properties/NotificationMetadata",
|
||||
"type": "object",
|
||||
"title": "The NotificationMetadata schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
|
||||
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime": "2019-03-20T18:59:48.768Z",
|
||||
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"ApplicationId",
|
||||
"SubscriptionId",
|
||||
"PublishTime",
|
||||
"NotificationId"
|
||||
],
|
||||
"properties": {
|
||||
"ApplicationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/ApplicationId",
|
||||
"type": "string",
|
||||
"title": "The ApplicationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"
|
||||
]
|
||||
},
|
||||
"SubscriptionId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/SubscriptionId",
|
||||
"type": "string",
|
||||
"title": "The SubscriptionId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"93b098e1-c42-2f45-93a1-78910a6a8369"
|
||||
]
|
||||
},
|
||||
"PublishTime": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/PublishTime",
|
||||
"type": "string",
|
||||
"title": "The PublishTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:48.768Z"
|
||||
]
|
||||
},
|
||||
"NotificationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/NotificationId",
|
||||
"type": "string",
|
||||
"title": "The NotificationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "http://example.com/example.json",
|
||||
"type": "object",
|
||||
"description": "The root schema comprises the entire JSON document.",
|
||||
"examples": [
|
||||
{
|
||||
"NotificationVersion": "1.0",
|
||||
"NotificationType": "FBA_OUTBOUND_SHIPMENT_STATUS",
|
||||
"PayloadVersion": "1.0",
|
||||
"EventTime": "2020-01-11T00:09:53.109Z",
|
||||
"Payload": {
|
||||
"FBAOutboundShipmentStatusNotification": {
|
||||
"SellerId": "merchantId",
|
||||
"AmazonOrderId": "113-2646096-4474645",
|
||||
"AmazonShipmentId": "DrLqQwqvb",
|
||||
"ShipmentStatus": "Created"
|
||||
}
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"ApplicationId": "appId",
|
||||
"SubscriptionId": "subId",
|
||||
"PublishTime": "2020-01-11T00:02:50.501Z",
|
||||
"NotificationId": "requestId"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"NotificationVersion",
|
||||
"NotificationType",
|
||||
"PayloadVersion",
|
||||
"EventTime",
|
||||
"NotificationMetadata",
|
||||
"Payload"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"NotificationVersion": {
|
||||
"$id": "#/properties/NotificationVersion",
|
||||
"type": "string"
|
||||
},
|
||||
"NotificationType": {
|
||||
"$id": "#/properties/NotificationType",
|
||||
"type": "string"
|
||||
},
|
||||
"PayloadVersion": {
|
||||
"$id": "#/properties/PayloadVersion",
|
||||
"type": "string"
|
||||
},
|
||||
"EventTime": {
|
||||
"$id": "#/properties/EventTime",
|
||||
"type": "string"
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"$id": "#/properties/NotificationMetadata",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"ApplicationId",
|
||||
"SubscriptionId",
|
||||
"PublishTime",
|
||||
"NotificationId"
|
||||
],
|
||||
"properties": {
|
||||
"ApplicationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/ApplicationId",
|
||||
"type": "string"
|
||||
},
|
||||
"SubscriptionId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/SubscriptionId",
|
||||
"type": "string"
|
||||
},
|
||||
"PublishTime": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/PublishTime",
|
||||
"type": "string"
|
||||
},
|
||||
"NotificationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/NotificationId",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Payload": {
|
||||
"$id": "#/properties/Payload",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"FBAOutboundShipmentStatusNotification"
|
||||
],
|
||||
"properties": {
|
||||
"FBAOutboundShipmentStatusNotification": {
|
||||
"$id": "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"SellerId",
|
||||
"AmazonOrderId",
|
||||
"AmazonShipmentId",
|
||||
"ShipmentStatus"
|
||||
],
|
||||
"properties": {
|
||||
"SellerId": {
|
||||
"$id": "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification/properties/SellerId",
|
||||
"type": "string"
|
||||
},
|
||||
"AmazonOrderId": {
|
||||
"$id": "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification/properties/AmazonOrderId",
|
||||
"type": "string"
|
||||
},
|
||||
"AmazonShipmentId": {
|
||||
"$id": "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification/properties/AmazonShipmentId",
|
||||
"type": "string"
|
||||
},
|
||||
"ShipmentStatus": {
|
||||
"$id": "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification/properties/ShipmentStatus",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,214 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "http://example.com/example.json",
|
||||
"type": "object",
|
||||
"description": "The root schema comprises the entire JSON document.",
|
||||
"examples": [
|
||||
{
|
||||
"notificationVersion": "2020-09-04",
|
||||
"notificationType": "FEED_PROCESSING_FINISHED",
|
||||
"payloadVersion": "2020-09-04",
|
||||
"eventTime": "2020-07-13T19:42:04.284Z",
|
||||
"payload": {
|
||||
"feedProcessingFinishedNotification": {
|
||||
"sellerId": "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"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"notificationVersion",
|
||||
"notificationType",
|
||||
"payloadVersion",
|
||||
"eventTime",
|
||||
"payload",
|
||||
"notificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"notificationVersion": {
|
||||
"$id": "#/properties/notificationVersion",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"2020-09-04"
|
||||
]
|
||||
},
|
||||
"notificationType": {
|
||||
"$id": "#/properties/notificationType",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"FEED_PROCESSING_FINISHED"
|
||||
]
|
||||
},
|
||||
"payloadVersion": {
|
||||
"$id": "#/properties/payloadVersion",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"2020-09-04"
|
||||
]
|
||||
},
|
||||
"eventTime": {
|
||||
"$id": "#/properties/eventTime",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"payload": {
|
||||
"$id": "#/properties/payload",
|
||||
"type": "object",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
{
|
||||
"feedProcessingFinishedNotification": {
|
||||
"sellerId": "A3TH9S8BH6GOGM",
|
||||
"feedId": "53347018456",
|
||||
"feedType": "POST_PRODUCT_DATA",
|
||||
"processingStatus": "DONE",
|
||||
"resultFeedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"feedProcessingFinishedNotification"
|
||||
],
|
||||
"properties": {
|
||||
"feedProcessingFinishedNotification": {
|
||||
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification",
|
||||
"type": "object",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
{
|
||||
"sellerId": "A3TH9S8BH6GOGM",
|
||||
"feedId": "53347018456",
|
||||
"feedType": "POST_PRODUCT_DATA",
|
||||
"processingStatus": "DONE",
|
||||
"resultFeedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"sellerId",
|
||||
"feedId",
|
||||
"feedType",
|
||||
"processingStatus"
|
||||
],
|
||||
"properties": {
|
||||
"sellerId": {
|
||||
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/sellerId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"A3TH9S8BH6GOGM"
|
||||
]
|
||||
},
|
||||
"feedId": {
|
||||
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"53347018456"
|
||||
]
|
||||
},
|
||||
"feedType": {
|
||||
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedType",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"POST_PRODUCT_DATA"
|
||||
]
|
||||
},
|
||||
"processingStatus": {
|
||||
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/processingStatus",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"CANCELLED",
|
||||
"DONE",
|
||||
"FATAL"
|
||||
],
|
||||
"enum": [
|
||||
"CANCELLED",
|
||||
"DONE",
|
||||
"FATAL"
|
||||
]
|
||||
},
|
||||
"resultFeedDocumentId": {
|
||||
"$id": "#/properties/payload/properties/feedProcessingFinishedNotification/properties/resultFeedDocumentId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"notificationMetadata": {
|
||||
"$id": "#/properties/notificationMetadata",
|
||||
"type": "object",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
{
|
||||
"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"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"applicationId",
|
||||
"subscriptionId",
|
||||
"publishTime",
|
||||
"notificationId"
|
||||
],
|
||||
"properties": {
|
||||
"applicationId": {
|
||||
"$id": "#/properties/notificationMetadata/properties/applicationId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746"
|
||||
]
|
||||
},
|
||||
"subscriptionId": {
|
||||
"$id": "#/properties/notificationMetadata/properties/subscriptionId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
},
|
||||
"publishTime": {
|
||||
"$id": "#/properties/notificationMetadata/properties/publishTime",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"notificationId": {
|
||||
"$id": "#/properties/notificationMetadata/properties/notificationId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,605 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "http://example.com/example.json",
|
||||
"type": "object",
|
||||
"title": "The root schema",
|
||||
"description": "The root schema comprises the entire JSON document.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"NotificationVersion": "1.0",
|
||||
"NotificationType": "FULFILLMENT_ORDER_STATUS",
|
||||
"PayloadVersion": "1.0",
|
||||
"EventTime": "2020-07-13T19:42:04.284Z",
|
||||
"Payload": {
|
||||
"FulfillmentOrderStatusNotification": {
|
||||
"SellerId": "A3TH9S8BH6GOGM",
|
||||
"EventType": "TYPE3945",
|
||||
"StatusUpdatedDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"SellerFulfillmentOrderId": "SFOID2345",
|
||||
"FulfillmentOrderStatus": "PROCESSED",
|
||||
"FulfillmentShipment": {
|
||||
"FulfillmentShipmentStatus": "PROCESSED",
|
||||
"AmazonShipmentId": "ASID49535",
|
||||
"EstimatedArrivalDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"info": {
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
"FulfillmentShipmentPackages": [
|
||||
{
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
{
|
||||
"PackageNumber": 2,
|
||||
"CarrierCode": "1-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
{
|
||||
"PackageNumber": 3,
|
||||
"CarrierCode": "3-930434",
|
||||
"TrackingNumber": "1Z885647654573405"
|
||||
}
|
||||
]
|
||||
},
|
||||
"FulfillmentReturnItem": {
|
||||
"ReceivedDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"ReturnedQuantity": 12,
|
||||
"SellerSKU": "SELLERSKU9345"
|
||||
}
|
||||
}
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"PublishTime": "2020-07-13T19:42:04.284Z",
|
||||
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"NotificationVersion",
|
||||
"NotificationType",
|
||||
"PayloadVersion",
|
||||
"EventTime",
|
||||
"Payload",
|
||||
"NotificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"NotificationVersion": {
|
||||
"$id": "#/properties/NotificationVersion",
|
||||
"type": "string",
|
||||
"title": "The NotificationVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"NotificationType": {
|
||||
"$id": "#/properties/NotificationType",
|
||||
"type": "string",
|
||||
"title": "The NotificationType schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"FULFILLMENT_ORDER_STATUS"
|
||||
]
|
||||
},
|
||||
"PayloadVersion": {
|
||||
"$id": "#/properties/PayloadVersion",
|
||||
"type": "string",
|
||||
"title": "The PayloadVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"EventTime": {
|
||||
"$id": "#/properties/EventTime",
|
||||
"type": "string",
|
||||
"title": "The EventTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"Payload": {
|
||||
"$id": "#/properties/Payload",
|
||||
"type": "object",
|
||||
"title": "The Payload schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"FulfillmentOrderStatusNotification": {
|
||||
"SellerId": "A3TH9S8BH6GOGM",
|
||||
"EventType": "TYPE3945",
|
||||
"StatusUpdatedDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"SellerFulfillmentOrderId": "SFOID2345",
|
||||
"FulfillmentOrderStatus": "PROCESSED",
|
||||
"FulfillmentShipment": {
|
||||
"FulfillmentShipmentStatus": "PROCESSED",
|
||||
"AmazonShipmentId": "ASID49535",
|
||||
"EstimatedArrivalDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"info": {
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
"FulfillmentShipmentPackages": [
|
||||
{
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
{
|
||||
"PackageNumber": 2,
|
||||
"CarrierCode": "1-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
{
|
||||
"PackageNumber": 3,
|
||||
"CarrierCode": "3-930434",
|
||||
"TrackingNumber": "1Z885647654573405"
|
||||
}
|
||||
]
|
||||
},
|
||||
"FulfillmentReturnItem": {
|
||||
"ReceivedDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"ReturnedQuantity": 12,
|
||||
"SellerSKU": "SELLERSKU9345"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"FulfillmentOrderStatusNotification"
|
||||
],
|
||||
"properties": {
|
||||
"FulfillmentOrderStatusNotification": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification",
|
||||
"type": "object",
|
||||
"title": "The FulfillmentOrderStatusNotification schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"SellerId": "A3TH9S8BH6GOGM",
|
||||
"EventType": "TYPE3945",
|
||||
"StatusUpdatedDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"SellerFulfillmentOrderId": "SFOID2345",
|
||||
"FulfillmentOrderStatus": "PROCESSED",
|
||||
"FulfillmentShipment": {
|
||||
"FulfillmentShipmentStatus": "PROCESSED",
|
||||
"AmazonShipmentId": "ASID49535",
|
||||
"EstimatedArrivalDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"info": {
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
"FulfillmentShipmentPackages": [
|
||||
{
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
{
|
||||
"PackageNumber": 2,
|
||||
"CarrierCode": "1-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
{
|
||||
"PackageNumber": 3,
|
||||
"CarrierCode": "3-930434",
|
||||
"TrackingNumber": "1Z885647654573405"
|
||||
}
|
||||
]
|
||||
},
|
||||
"FulfillmentReturnItem": {
|
||||
"ReceivedDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"ReturnedQuantity": 12,
|
||||
"SellerSKU": "SELLERSKU9345"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"SellerId",
|
||||
"EventType",
|
||||
"StatusUpdatedDateTime",
|
||||
"SellerFulfillmentOrderId",
|
||||
"FulfillmentOrderStatus",
|
||||
"FulfillmentShipment",
|
||||
"FulfillmentReturnItem"
|
||||
],
|
||||
"properties": {
|
||||
"SellerId": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/SellerId",
|
||||
"type": "string",
|
||||
"title": "The SellerId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"A3TH9S8BH6GOGM"
|
||||
]
|
||||
},
|
||||
"EventType": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/EventType",
|
||||
"type": "string",
|
||||
"title": "The EventType schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"TYPE3945"
|
||||
]
|
||||
},
|
||||
"StatusUpdatedDateTime": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/StatusUpdatedDateTime",
|
||||
"type": "string",
|
||||
"title": "The StatusUpdatedDateTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"SellerFulfillmentOrderId": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/SellerFulfillmentOrderId",
|
||||
"type": "string",
|
||||
"title": "The SellerFulfillmentOrderId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"SFOID2345"
|
||||
]
|
||||
},
|
||||
"FulfillmentOrderStatus": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentOrderStatus",
|
||||
"type": "string",
|
||||
"title": "The FulfillmentOrderStatus schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"PROCESSED"
|
||||
]
|
||||
},
|
||||
"FulfillmentShipment": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment",
|
||||
"type": "object",
|
||||
"title": "The FulfillmentShipment schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"FulfillmentShipmentStatus": "PROCESSED",
|
||||
"AmazonShipmentId": "ASID49535",
|
||||
"EstimatedArrivalDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"info": {
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
"FulfillmentShipmentPackages": [
|
||||
{
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
{
|
||||
"PackageNumber": 2,
|
||||
"CarrierCode": "1-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
{
|
||||
"PackageNumber": 3,
|
||||
"CarrierCode": "3-930434",
|
||||
"TrackingNumber": "1Z885647654573405"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"FulfillmentShipmentStatus",
|
||||
"AmazonShipmentId",
|
||||
"EstimatedArrivalDateTime",
|
||||
"info",
|
||||
"FulfillmentShipmentPackages"
|
||||
],
|
||||
"properties": {
|
||||
"FulfillmentShipmentStatus": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentStatus",
|
||||
"type": "string",
|
||||
"title": "The FulfillmentShipmentStatus schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"PROCESSED"
|
||||
]
|
||||
},
|
||||
"AmazonShipmentId": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/AmazonShipmentId",
|
||||
"type": "string",
|
||||
"title": "The AmazonShipmentId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"ASID49535"
|
||||
]
|
||||
},
|
||||
"EstimatedArrivalDateTime": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/EstimatedArrivalDateTime",
|
||||
"type": "string",
|
||||
"title": "The EstimatedArrivalDateTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"FulfillmentShipmentPackages": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages",
|
||||
"type": "array",
|
||||
"title": "The FulfillmentShipmentPackages schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": [],
|
||||
"examples": [
|
||||
[
|
||||
{
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
},
|
||||
{
|
||||
"PackageNumber": 2,
|
||||
"CarrierCode": "1-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
}
|
||||
]
|
||||
],
|
||||
"properties": {
|
||||
"FulfillmentShipmentPackageItem": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/properties/FulfillmentShipmentPackageItem",
|
||||
"type": "object",
|
||||
"title": "The info schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"PackageNumber",
|
||||
"CarrierCode",
|
||||
"TrackingNumber"
|
||||
],
|
||||
"properties": {
|
||||
"PackageNumber": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/info/properties/PackageNumber",
|
||||
"type": "integer",
|
||||
"title": "The PackageNumber schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": 0,
|
||||
"examples": [
|
||||
1
|
||||
]
|
||||
},
|
||||
"CarrierCode": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/info/properties/CarrierCode",
|
||||
"type": "string",
|
||||
"title": "The CarrierCode schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2-930434"
|
||||
]
|
||||
},
|
||||
"TrackingNumber": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/info/properties/TrackingNumber",
|
||||
"type": "string",
|
||||
"title": "The TrackingNumber schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1Z84456456573405"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalItems": true,
|
||||
"items": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/properties/FulfillmentShipmentPackageItem",
|
||||
"anyOf": [
|
||||
{
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0",
|
||||
"type": "object",
|
||||
"title": "The first anyOf schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"PackageNumber": 1,
|
||||
"CarrierCode": "2-930434",
|
||||
"TrackingNumber": "1Z84456456573405"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"PackageNumber",
|
||||
"CarrierCode",
|
||||
"TrackingNumber"
|
||||
],
|
||||
"properties": {
|
||||
"PackageNumber": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0/properties/PackageNumber",
|
||||
"type": "integer",
|
||||
"title": "The PackageNumber schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": 0,
|
||||
"examples": [
|
||||
1
|
||||
]
|
||||
},
|
||||
"CarrierCode": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0/properties/CarrierCode",
|
||||
"type": "string",
|
||||
"title": "The CarrierCode schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2-930434"
|
||||
]
|
||||
},
|
||||
"TrackingNumber": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0/properties/TrackingNumber",
|
||||
"type": "string",
|
||||
"title": "The TrackingNumber schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1Z84456456573405"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"FulfillmentReturnItem": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem",
|
||||
"type": "object",
|
||||
"title": "The FulfillmentReturnItem schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"ReceivedDateTime": "2020-07-13T19:42:04.284Z",
|
||||
"ReturnedQuantity": 12,
|
||||
"SellerSKU": "SELLERSKU9345"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"ReceivedDateTime",
|
||||
"ReturnedQuantity",
|
||||
"SellerSKU"
|
||||
],
|
||||
"properties": {
|
||||
"ReceivedDateTime": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem/properties/ReceivedDateTime",
|
||||
"type": "string",
|
||||
"title": "The ReceivedDateTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"ReturnedQuantity": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem/properties/ReturnedQuantity",
|
||||
"type": "integer",
|
||||
"title": "The ReturnedQuantity schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": 0,
|
||||
"examples": [
|
||||
12
|
||||
]
|
||||
},
|
||||
"SellerSKU": {
|
||||
"$id": "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem/properties/SellerSKU",
|
||||
"type": "string",
|
||||
"title": "The SellerSKU schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"SELLERSKU9345"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"$id": "#/properties/NotificationMetadata",
|
||||
"type": "object",
|
||||
"title": "The NotificationMetadata schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"PublishTime": "2020-07-13T19:42:04.284Z",
|
||||
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"ApplicationId",
|
||||
"SubscriptionId",
|
||||
"PublishTime",
|
||||
"NotificationId"
|
||||
],
|
||||
"properties": {
|
||||
"ApplicationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/ApplicationId",
|
||||
"type": "string",
|
||||
"title": "The ApplicationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
},
|
||||
"SubscriptionId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/SubscriptionId",
|
||||
"type": "string",
|
||||
"title": "The SubscriptionId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
},
|
||||
"PublishTime": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/PublishTime",
|
||||
"type": "string",
|
||||
"title": "The PublishTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"NotificationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/NotificationId",
|
||||
"type": "string",
|
||||
"title": "The NotificationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
|
|
@ -0,0 +1,207 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "http://example.com/example.json",
|
||||
"type": "object",
|
||||
"title": "The root schema",
|
||||
"description": "The root schema comprises the entire JSON document.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"NotificationVersion": "1.0",
|
||||
"NotificationType": "ITEM_PRODUCT_TYPE_CHANGE",
|
||||
"PayloadVersion": "1.0",
|
||||
"EventTime": "2019-03-20T18:59:30.194Z",
|
||||
"Payload": {
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"Asin": "B1234567",
|
||||
"PreviousProductType": "PET_HEALTH_CARE",
|
||||
"CurrentProductType": "PET_APPAREL"
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
|
||||
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime": "2019-03-20T18:59:48.768Z",
|
||||
"NotificationId": "0e999936-da2c-4f9c-9fc2-02b67bae5f49"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"NotificationVersion",
|
||||
"NotificationType",
|
||||
"PayloadVersion",
|
||||
"EventTime",
|
||||
"Payload",
|
||||
"NotificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"NotificationVersion": {
|
||||
"$id": "#/properties/NotificationVersion",
|
||||
"type": "string",
|
||||
"title": "The NotificationVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"NotificationType": {
|
||||
"$id": "#/properties/NotificationType",
|
||||
"type": "string",
|
||||
"title": "The NotificationType schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"ITEM_PRODUCT_TYPE_CHANGE"
|
||||
]
|
||||
},
|
||||
"PayloadVersion": {
|
||||
"$id": "#/properties/PayloadVersion",
|
||||
"type": "string",
|
||||
"title": "The PayloadVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"EventTime": {
|
||||
"$id": "#/properties/EventTime",
|
||||
"type": "string",
|
||||
"title": "The EventTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:30.194Z"
|
||||
]
|
||||
},
|
||||
"Payload": {
|
||||
"$id": "#/properties/Payload",
|
||||
"type": "object",
|
||||
"title": "The Payload schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"Asin": "B1234567",
|
||||
"PreviousProductType": "PET_HEALTH_CARE",
|
||||
"CurrentProductType": "PET_APPAREL"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"MarketplaceId",
|
||||
"Asin",
|
||||
"PreviousProductType",
|
||||
"CurrentProductType"
|
||||
],
|
||||
"properties": {
|
||||
"MarketplaceId": {
|
||||
"$id": "#/properties/Payload/properties/MarketplaceId",
|
||||
"type": "string",
|
||||
"title": "The MarketplaceId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"Asin": {
|
||||
"$id": "#/properties/Payload/properties/Asin",
|
||||
"type": "string",
|
||||
"title": "The Asin schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"B1234567"
|
||||
]
|
||||
},
|
||||
"PreviousProductType": {
|
||||
"$id": "#/properties/Payload/properties/PreviousProductType",
|
||||
"type": "string",
|
||||
"title": "The PreviousProductType schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"PET_HEALTH_CARE"
|
||||
]
|
||||
},
|
||||
"CurrentProductType": {
|
||||
"$id": "#/properties/Payload/properties/CurrentProductType",
|
||||
"type": "string",
|
||||
"title": "The CurrentProductType schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"PET_APPAREL"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"$id": "#/properties/NotificationMetadata",
|
||||
"type": "object",
|
||||
"title": "The NotificationMetadata schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
|
||||
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime": "2019-03-20T18:59:48.768Z",
|
||||
"NotificationId": "0e999936-da2c-4f9c-9fc2-02b67bae5f49"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"ApplicationId",
|
||||
"SubscriptionId",
|
||||
"PublishTime",
|
||||
"NotificationId"
|
||||
],
|
||||
"properties": {
|
||||
"ApplicationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/ApplicationId",
|
||||
"type": "string",
|
||||
"title": "The ApplicationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"
|
||||
]
|
||||
},
|
||||
"SubscriptionId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/SubscriptionId",
|
||||
"type": "string",
|
||||
"title": "The SubscriptionId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"93b098e1-c42-2f45-93a1-78910a6a8369"
|
||||
]
|
||||
},
|
||||
"PublishTime": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/PublishTime",
|
||||
"type": "string",
|
||||
"title": "The PublishTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:48.768Z"
|
||||
]
|
||||
},
|
||||
"NotificationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/NotificationId",
|
||||
"type": "string",
|
||||
"title": "The NotificationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
|
|
@ -0,0 +1,245 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"title": "Listings Item Issues Change Notification",
|
||||
"description": "To be delivered when issues are created, changed, or resolved for a listings item.",
|
||||
"type": "object",
|
||||
"examples": [
|
||||
{
|
||||
"NotificationVersion": "1.0",
|
||||
"NotificationType": "LISTINGS_ITEM_ISSUES_CHANGE",
|
||||
"PayloadVersion": "1.0",
|
||||
"EventTime": "2021-02-05T18:59:30.194Z",
|
||||
"Payload": {
|
||||
"SellerId": "AXXXXXXXXXXXXX",
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"Asin": "BT6RZ7JM4H",
|
||||
"Sku": "NLS-SHOES-03",
|
||||
"Severities": [
|
||||
"ERROR",
|
||||
"WARNING"
|
||||
],
|
||||
"EnforcementActions": [
|
||||
"SEARCH_SUPPRESSED"
|
||||
]
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"ApplicationId": "amzn1.sellerapps.app.f108f511-eeac-46a6-b125-bcb752069ed0",
|
||||
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime": "2021-02-05T18:59:48.768Z",
|
||||
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"NotificationVersion",
|
||||
"NotificationType",
|
||||
"PayloadVersion",
|
||||
"EventTime",
|
||||
"Payload",
|
||||
"NotificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"NotificationVersion": {
|
||||
"type": "string",
|
||||
"title": "Notification Version",
|
||||
"description": "The version of the notification.",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"NotificationType": {
|
||||
"type": "string",
|
||||
"title": "Notification Type",
|
||||
"description": "The type of the notification.",
|
||||
"enum": ["LISTINGS_ITEM_ISSUES_CHANGE"]
|
||||
},
|
||||
"PayloadVersion": {
|
||||
"type": "string",
|
||||
"title": "Payload Version",
|
||||
"description": "The version of the payload.",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"EventTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Event Time",
|
||||
"description": "Timestamp of the event, formatted as ISO8601 date-time.",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:30.194Z"
|
||||
]
|
||||
},
|
||||
"Payload": {
|
||||
"type": "object",
|
||||
"title": "Payload",
|
||||
"description": "The details of this notification.",
|
||||
"examples": [
|
||||
{
|
||||
"SellerId": "A3AYAZLIQ7AX77",
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"Asin": "BT6RZ7JM4H",
|
||||
"Sku": "NLS-SHOES-03",
|
||||
"Severities": [
|
||||
"ERROR",
|
||||
"WARNING"
|
||||
],
|
||||
"EnforcementActions": [
|
||||
"SEARCH_SUPPRESSED"
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"SellerId",
|
||||
"Sku",
|
||||
"Severities"
|
||||
],
|
||||
"properties": {
|
||||
"SellerId": {
|
||||
"type": "string",
|
||||
"title": "Seller ID",
|
||||
"description": "Selling partner identifier, such as a merchant account or vendor code, of the affected listings item.",
|
||||
"examples": [
|
||||
"AXXXXXXXXXXXXX",
|
||||
"TXXXX"
|
||||
]
|
||||
},
|
||||
"MarketplaceId": {
|
||||
"type": "string",
|
||||
"title": "Marketplace ID",
|
||||
"description": "Amazon marketplace identifier of the affected listings item.",
|
||||
"examples": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"Asin": {
|
||||
"type": "string",
|
||||
"title": "ASIN",
|
||||
"description": "The Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item.",
|
||||
"examples": [
|
||||
"BT6RZ7JM4H"
|
||||
]
|
||||
},
|
||||
"Sku": {
|
||||
"type": "string",
|
||||
"title": "SKU",
|
||||
"description": "Identifier of the affected listings item.",
|
||||
"examples": [
|
||||
"NLS-SHOES-03"
|
||||
]
|
||||
},
|
||||
"Severities": {
|
||||
"type": "array",
|
||||
"title": "Severities",
|
||||
"description": "Array of severities for the issues currently associated with the affected listings item. When no issues are affecting the listings item, \"NONE\" is provided instead.",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"NONE",
|
||||
"ERROR",
|
||||
"WARNING"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "NONE",
|
||||
"description": "When provided, no issues are affecting the listings item."
|
||||
},
|
||||
{
|
||||
"value": "ERROR",
|
||||
"description": "When provided, at least one issue with \"ERROR\" severity is affecting the listings item."
|
||||
},
|
||||
{
|
||||
"value": "WARNING",
|
||||
"description": "When provided, at least one issue with \"WARNING\" severity is affecting the listings item."
|
||||
}
|
||||
]
|
||||
},
|
||||
"uniqueItems": true,
|
||||
"examples": [
|
||||
[
|
||||
"ERROR",
|
||||
"WARNING"
|
||||
]
|
||||
]
|
||||
},
|
||||
"EnforcementActions": {
|
||||
"type": "array",
|
||||
"title": "Enforcement Actions Taken",
|
||||
"description": "Array of enforcement actions taken by Amazon for the issues associated with the affected listings item.",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"SEARCH_SUPPRESSED"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "SEARCH_SUPPRESSED",
|
||||
"description": "When provided, the listing item is suppressed from search results caused by at least one issue currently associated with the affected listing item."
|
||||
}
|
||||
]
|
||||
},
|
||||
"uniqueItems": true,
|
||||
"examples": [
|
||||
[
|
||||
"SEARCH_SUPPRESSED"
|
||||
]
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"type": "object",
|
||||
"title": "Notification Metadata",
|
||||
"description": "The metadata of the notification.",
|
||||
"examples": [
|
||||
{
|
||||
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
|
||||
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime": "2019-03-20T18:59:48.768Z",
|
||||
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"ApplicationId",
|
||||
"SubscriptionId",
|
||||
"PublishTime",
|
||||
"NotificationId"
|
||||
],
|
||||
"properties": {
|
||||
"ApplicationId": {
|
||||
"type": "string",
|
||||
"title": "Application ID",
|
||||
"description": "Identifies the application.",
|
||||
"examples": [
|
||||
"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"
|
||||
]
|
||||
},
|
||||
"SubscriptionId": {
|
||||
"type": "string",
|
||||
"title": "Subscription ID",
|
||||
"description": "Identifies the subscription.",
|
||||
"examples": [
|
||||
"93b098e1-c42-2f45-93a1-78910a6a8369"
|
||||
]
|
||||
},
|
||||
"PublishTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Publish Time",
|
||||
"description": "Timestamp of when the notification was published, formatted as ISO8601 date-time.",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:48.768Z"
|
||||
]
|
||||
},
|
||||
"NotificationId": {
|
||||
"type": "string",
|
||||
"title": "Notification ID",
|
||||
"description": "Identifies the notification.",
|
||||
"examples": [
|
||||
"8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,226 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"title": "Listings Item Status Change Notification",
|
||||
"description": "To be delivered when the status (e.g. buyability, discoverability) of a listings item changes.",
|
||||
"type": "object",
|
||||
"examples": [
|
||||
{
|
||||
"NotificationVersion": "1.0",
|
||||
"NotificationType": "LISTINGS_ITEM_STATUS_CHANGE",
|
||||
"PayloadVersion": "1.0",
|
||||
"EventTime": "2021-02-03T18:59:30.194Z",
|
||||
"Payload": {
|
||||
"SellerId": "A3AYAZLIQ7AX77",
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"Asin": "BT6RZ7JM4H",
|
||||
"Sku": "NLS-SHOES-03",
|
||||
"CreatedDate": "2021-02-03T18:50:26.196Z",
|
||||
"Status": [
|
||||
"BUYABLE",
|
||||
"DISCOVERABLE"
|
||||
]
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"ApplicationId": "amzn1.sellerapps.app.f108f511-eeac-46a6-b125-bcb752069ed0",
|
||||
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime": "2021-02-03T18:59:30.194Z",
|
||||
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"NotificationVersion",
|
||||
"NotificationType",
|
||||
"PayloadVersion",
|
||||
"EventTime",
|
||||
"Payload",
|
||||
"NotificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"NotificationVersion": {
|
||||
"type": "string",
|
||||
"title": "Notification Version",
|
||||
"description": "The version of the notification.",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"NotificationType": {
|
||||
"type": "string",
|
||||
"title": "Notification Type",
|
||||
"description": "The type of the notification.",
|
||||
"enum": ["LISTINGS_ITEM_STATUS_CHANGED"]
|
||||
},
|
||||
"PayloadVersion": {
|
||||
"type": "string",
|
||||
"title": "Payload Version",
|
||||
"description": "The version of the payload.",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"EventTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Event Time",
|
||||
"description": "Timestamp of the event, formatted as ISO8601 date-time.",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:30.194Z"
|
||||
]
|
||||
},
|
||||
"Payload": {
|
||||
"type": "object",
|
||||
"title": "Payload",
|
||||
"description": "The details of this notification.",
|
||||
"examples": [
|
||||
{
|
||||
"SellerId": "A3AYAZLIQ7AX77",
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"Asin": "BT6RZ7JM4H",
|
||||
"Sku": "NLS-SHOES-03",
|
||||
"CreatedDate": "2021-02-03T18:50:26.196Z",
|
||||
"Status": [
|
||||
"BUYABLE",
|
||||
"DISCOVERABLE"
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"SellerId",
|
||||
"Sku",
|
||||
"Status"
|
||||
],
|
||||
"properties": {
|
||||
"SellerId": {
|
||||
"type": "string",
|
||||
"title": "Seller ID",
|
||||
"description": "Selling partner identifier, such as a merchant account, of the affected listings item.",
|
||||
"examples": [
|
||||
"A3AYAZLIQ7AX77"
|
||||
]
|
||||
},
|
||||
"MarketplaceId": {
|
||||
"type": "string",
|
||||
"title": "Marketplace ID",
|
||||
"description": "Amazon marketplace identifier of the affected listings item.",
|
||||
"examples": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"Asin": {
|
||||
"type": "string",
|
||||
"title": "ASIN",
|
||||
"description": "The Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item.",
|
||||
"examples": [
|
||||
"BT6RZ7JM4H"
|
||||
]
|
||||
},
|
||||
"Sku": {
|
||||
"type": "string",
|
||||
"title": "SKU",
|
||||
"description": "Identifier of the affected listings item.",
|
||||
"examples": [
|
||||
"NLS-SHOES-03"
|
||||
]
|
||||
},
|
||||
"CreatedDate": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Created Date",
|
||||
"description": "Timestamp of when the listings item was created, formatted as ISO8601 date-time.",
|
||||
"examples": [
|
||||
"2021-02-03T18:50:26.196Z"
|
||||
]
|
||||
},
|
||||
"Status": {
|
||||
"type": "array",
|
||||
"title": "Status",
|
||||
"description": "Array of status states currently associated with the affected listings item. The absence of a value indicates the status state is not currently applicable to the listings item. For example, if \"BUYABLE\" is not present, the listings item is not currently buyable.",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"BUYABLE",
|
||||
"DISCOVERABLE",
|
||||
"DELETED"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "BUYABLE",
|
||||
"description": "When provided, the listings item is buyable. When omitted, the listings item is non-buyable."
|
||||
},
|
||||
{
|
||||
"value": "DISCOVERABLE",
|
||||
"description": "When provided, the listings item is discoverable. When omitted, the listings item is non-discoverable."
|
||||
},
|
||||
{
|
||||
"value": "DELETED",
|
||||
"description": "When provided, the listings item is deleted. When omitted, the listings item is non-deleted."
|
||||
}
|
||||
]
|
||||
},
|
||||
"uniqueItems": true,
|
||||
"examples": [
|
||||
[
|
||||
"BUYABLE",
|
||||
"DISCOVERABLE"
|
||||
]
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"type": "object",
|
||||
"title": "Notification Metadata",
|
||||
"description": "The metadata of the notification.",
|
||||
"examples": [
|
||||
{
|
||||
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
|
||||
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime": "2019-03-20T18:59:48.768Z",
|
||||
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"ApplicationId",
|
||||
"SubscriptionId",
|
||||
"PublishTime",
|
||||
"NotificationId"
|
||||
],
|
||||
"properties": {
|
||||
"ApplicationId": {
|
||||
"type": "string",
|
||||
"title": "Application ID",
|
||||
"description": "Identifies the application.",
|
||||
"examples": [
|
||||
"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"
|
||||
]
|
||||
},
|
||||
"SubscriptionId": {
|
||||
"type": "string",
|
||||
"title": "Subscription ID",
|
||||
"description": "Identifies the subscription.",
|
||||
"examples": [
|
||||
"93b098e1-c42-2f45-93a1-78910a6a8369"
|
||||
]
|
||||
},
|
||||
"PublishTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Publish Time",
|
||||
"description": "Timestamp of when the notification was published, formatted as ISO8601 date-time.",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:48.768Z"
|
||||
]
|
||||
},
|
||||
"NotificationId": {
|
||||
"type": "string",
|
||||
"title": "Notification ID",
|
||||
"description": "Identifies the notification.",
|
||||
"examples": [
|
||||
"8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,315 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "http://example.com/example.json",
|
||||
"type": "object",
|
||||
"title": "The root schema",
|
||||
"description": "The root schema comprises the entire JSON document.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"NotificationVersion": "1.0",
|
||||
"NotificationType": "MFN_ORDER_STATUS_CHANGE",
|
||||
"PayloadVersion": "1.0",
|
||||
"EventTime": "2020-07-13T19:42:04.284Z",
|
||||
"Payload": {
|
||||
"MFNOrderStatusChangeNotification": {
|
||||
"SellerId": "AXXXXXXXXXXXXX",
|
||||
"MarketplaceId" : "ATVPDKIKX0DER",
|
||||
"AmazonOrderId": "333-7777777-7777777",
|
||||
"PurchaseDate": 1595882000633,
|
||||
"OrderStatus": "SHIPPING",
|
||||
"DestinationPostalCode": "48110",
|
||||
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
|
||||
"OrderItemId": "OIID34853450",
|
||||
"SellerSKU": "SellerSKUID1",
|
||||
"Quantity": 45
|
||||
}
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"PublishTime": "2020-07-13T19:42:04.284Z",
|
||||
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"NotificationVersion",
|
||||
"NotificationType",
|
||||
"PayloadVersion",
|
||||
"EventTime",
|
||||
"Payload",
|
||||
"NotificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"NotificationVersion": {
|
||||
"$id": "#/properties/NotificationVersion",
|
||||
"type": "string",
|
||||
"title": "The NotificationVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"NotificationType": {
|
||||
"$id": "#/properties/NotificationType",
|
||||
"type": "string",
|
||||
"title": "The NotificationType schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"MFN_ORDER_STATUS_CHANGE"
|
||||
]
|
||||
},
|
||||
"PayloadVersion": {
|
||||
"$id": "#/properties/PayloadVersion",
|
||||
"type": "string",
|
||||
"title": "The PayloadVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"EventTime": {
|
||||
"$id": "#/properties/EventTime",
|
||||
"type": "string",
|
||||
"title": "The EventTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"Payload": {
|
||||
"$id": "#/properties/Payload",
|
||||
"type": "object",
|
||||
"title": "The Payload schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"MFNOrderStatusChangeNotification": {
|
||||
"SellerId": "AXXXXXXXXXXXXX",
|
||||
"MarketplaceId" : "ATVPDKIKX0DER",
|
||||
"AmazonOrderId": "333-7777777-7777777",
|
||||
"PurchaseDate": 1595882000633,
|
||||
"OrderStatus": "SHIPPING",
|
||||
"DestinationPostalCode": "48110",
|
||||
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
|
||||
"OrderItemId": "OIID34853450",
|
||||
"SellerSKU": "SellerSKUID1",
|
||||
"Quantity": 45
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"MFNOrderStatusChangeNotification"
|
||||
],
|
||||
"properties": {
|
||||
"MFNOrderStatusChangeNotification": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification",
|
||||
"type": "object",
|
||||
"title": "The MFNOrderStatusChangeNotification schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"SellerId": "AXXXXXXXXXXXXX",
|
||||
"MarketplaceId" : "ATVPDKIKX0DER",
|
||||
"AmazonOrderId": "333-7777777-7777777",
|
||||
"PurchaseDate": 1595882000633,
|
||||
"OrderStatus": "SHIPPING",
|
||||
"DestinationPostalCode": "48110",
|
||||
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
|
||||
"OrderItemId": "OIID34853450",
|
||||
"SellerSKU": "SellerSKUID1",
|
||||
"Quantity": 45
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"SellerId",
|
||||
"MarketplaceId",
|
||||
"AmazonOrderId",
|
||||
"PurchaseDate",
|
||||
"OrderStatus",
|
||||
"DestinationPostalCode",
|
||||
"SupplySourceId",
|
||||
"OrderItemId",
|
||||
"SellerSKU",
|
||||
"Quantity"
|
||||
],
|
||||
"properties": {
|
||||
"SellerId": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/SellerId",
|
||||
"type": "string",
|
||||
"title": "The SellerId schema",
|
||||
"description": "The selling partner identifier.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"AXXXXXXXXXXXXX"
|
||||
]
|
||||
},
|
||||
"MarketplaceId": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/MarketplaceId",
|
||||
"type": "string",
|
||||
"title": "The MarketplaceId schema",
|
||||
"description": "Amazon marketplace identifier of the affected order.",
|
||||
"examples": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"AmazonOrderId": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/AmazonOrderId",
|
||||
"type": "string",
|
||||
"title": "The AmazonOrderId schema",
|
||||
"description": "An Amazon-defined order identifier in 3-7-7 format.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"333-7777777-7777777"
|
||||
]
|
||||
},
|
||||
"PurchaseDate": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/PurchaseDate",
|
||||
"type": ["integer", "null"],
|
||||
"title": "The PurchaseDate schema",
|
||||
"description": "The purchase date of the order in Epoch time.",
|
||||
"default": 0,
|
||||
"examples": [
|
||||
1595882000633
|
||||
]
|
||||
},
|
||||
"OrderStatus": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/OrderStatus",
|
||||
"type": "string",
|
||||
"title": "The OrderStatus schema",
|
||||
"description": "The current order status, its possible values are UPCOMINGORDER, PENDING, SHIPPING, WAITING, CANCELED, INVOICEUNCONFIRMED, SHIPPED and UNFULFILLABLE.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"SHIPPING"
|
||||
]
|
||||
},
|
||||
"DestinationPostalCode": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/DestinationPostalCode",
|
||||
"type": ["string", "null"],
|
||||
"title": "The DestinationPostalCode schema",
|
||||
"description": "The destination postal code.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"48110"
|
||||
]
|
||||
},
|
||||
"SupplySourceId": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/SupplySourceId",
|
||||
"type": ["string", "null"],
|
||||
"title": "The SupplySourceId schema",
|
||||
"description": "The unique identifier of the supply source.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"55448834-0d79-5155-75c4-8529543a7c31"
|
||||
]
|
||||
},
|
||||
"OrderItemId": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/OrderItemId",
|
||||
"type": "string",
|
||||
"title": "The OrderItemId schema",
|
||||
"description": "The Amazon-defined order item identifier.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"OIID34853450"
|
||||
]
|
||||
},
|
||||
"SellerSKU": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/SellerSKU",
|
||||
"type": "string",
|
||||
"title": "The SellerSKU schema",
|
||||
"description": "The seller-specific SKU identifier for an item.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"SellerSKUID1"
|
||||
]
|
||||
},
|
||||
"Quantity": {
|
||||
"$id": "#/properties/Payload/properties/MFNOrderStatusChangeNotification/properties/Quantity",
|
||||
"type": "integer",
|
||||
"title": "The Quantity schema",
|
||||
"description": "The number of items in the order.",
|
||||
"default": 0,
|
||||
"examples": [
|
||||
45
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"$id": "#/properties/NotificationMetadata",
|
||||
"type": "object",
|
||||
"title": "The NotificationMetadata schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"PublishTime": "2020-07-13T19:42:04.284Z",
|
||||
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"ApplicationId",
|
||||
"SubscriptionId",
|
||||
"PublishTime",
|
||||
"NotificationId"
|
||||
],
|
||||
"properties": {
|
||||
"ApplicationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/ApplicationId",
|
||||
"type": "string",
|
||||
"title": "The ApplicationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
},
|
||||
"SubscriptionId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/SubscriptionId",
|
||||
"type": "string",
|
||||
"title": "The SubscriptionId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
},
|
||||
"PublishTime": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/PublishTime",
|
||||
"type": "string",
|
||||
"title": "The PublishTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"NotificationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/NotificationId",
|
||||
"type": "string",
|
||||
"title": "The NotificationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
|
|
@ -0,0 +1,328 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "http://example.com/example.json",
|
||||
"type": "object",
|
||||
"title": "The root schema",
|
||||
"description": "The root schema comprises the entire JSON document.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"NotificationVersion": "1.0",
|
||||
"NotificationType": "ORDER_STATUS_CHANGE",
|
||||
"PayloadVersion": "1.0",
|
||||
"EventTime": "2020-07-13T19:42:04.284Z",
|
||||
"Payload": {
|
||||
"OrderStatusChangeNotification": {
|
||||
"SellerId": "AXXXXXXXXXXXXX",
|
||||
"MarketplaceId" : "ATVPDKIKX0DER",
|
||||
"AmazonOrderId": "333-7777777-7777777",
|
||||
"PurchaseDate": 1595882000633,
|
||||
"OrderStatus": "Unshipped",
|
||||
"DestinationPostalCode": "48110",
|
||||
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
|
||||
"OrderItemId": "OIID34853450",
|
||||
"SellerSKU": "SellerSKUID1",
|
||||
"Quantity": 45,
|
||||
"FulfillmentChannel": "MFN"
|
||||
}
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"PublishTime": "2020-07-13T19:42:04.284Z",
|
||||
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"NotificationVersion",
|
||||
"NotificationType",
|
||||
"PayloadVersion",
|
||||
"EventTime",
|
||||
"Payload",
|
||||
"NotificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"NotificationVersion": {
|
||||
"$id": "#/properties/NotificationVersion",
|
||||
"type": "string",
|
||||
"title": "The NotificationVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"NotificationType": {
|
||||
"$id": "#/properties/NotificationType",
|
||||
"type": "string",
|
||||
"title": "The NotificationType schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"ORDER_STATUS_CHANGE"
|
||||
]
|
||||
},
|
||||
"PayloadVersion": {
|
||||
"$id": "#/properties/PayloadVersion",
|
||||
"type": "string",
|
||||
"title": "The PayloadVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"EventTime": {
|
||||
"$id": "#/properties/EventTime",
|
||||
"type": "string",
|
||||
"title": "The EventTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"Payload": {
|
||||
"$id": "#/properties/Payload",
|
||||
"type": "object",
|
||||
"title": "The Payload schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"OrderStatusChangeNotification": {
|
||||
"SellerId": "AXXXXXXXXXXXXX",
|
||||
"MarketplaceId" : "ATVPDKIKX0DER",
|
||||
"AmazonOrderId": "333-7777777-7777777",
|
||||
"PurchaseDate": 1595882000633,
|
||||
"OrderStatus": "Unshipped",
|
||||
"DestinationPostalCode": "48110",
|
||||
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
|
||||
"OrderItemId": "OIID34853450",
|
||||
"SellerSKU": "SellerSKUID1",
|
||||
"Quantity": 45,
|
||||
"FulfillmentChannel": "MFN"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"OrderStatusChangeNotification"
|
||||
],
|
||||
"properties": {
|
||||
"OrderStatusChangeNotification": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification",
|
||||
"type": "object",
|
||||
"title": "The OrderStatusChangeNotification schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"SellerId": "AXXXXXXXXXXXXX",
|
||||
"MarketplaceId" : "ATVPDKIKX0DER",
|
||||
"AmazonOrderId": "333-7777777-7777777",
|
||||
"PurchaseDate": 1595882000633,
|
||||
"OrderStatus": "Unshipped",
|
||||
"DestinationPostalCode": "48110",
|
||||
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
|
||||
"OrderItemId": "OIID34853450",
|
||||
"SellerSKU": "SellerSKUID1",
|
||||
"Quantity": 45,
|
||||
"FulfillmentChannel": "MFN"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"SellerId",
|
||||
"MarketplaceId",
|
||||
"AmazonOrderId",
|
||||
"PurchaseDate",
|
||||
"OrderStatus",
|
||||
"DestinationPostalCode",
|
||||
"SupplySourceId",
|
||||
"OrderItemId",
|
||||
"SellerSKU",
|
||||
"Quantity",
|
||||
"FulfillmentChannel"
|
||||
],
|
||||
"properties": {
|
||||
"SellerId": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/SellerId",
|
||||
"type": "string",
|
||||
"title": "The SellerId schema",
|
||||
"description": "The selling partner identifier.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"AXXXXXXXXXXXXX"
|
||||
]
|
||||
},
|
||||
"MarketplaceId": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/MarketplaceId",
|
||||
"type": "string",
|
||||
"title": "The MarketplaceId schema",
|
||||
"description": "Amazon marketplace identifier of the affected order.",
|
||||
"examples": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"AmazonOrderId": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/AmazonOrderId",
|
||||
"type": "string",
|
||||
"title": "The AmazonOrderId schema",
|
||||
"description": "An Amazon-defined order identifier in 3-7-7 format.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"333-7777777-7777777"
|
||||
]
|
||||
},
|
||||
"PurchaseDate": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/PurchaseDate",
|
||||
"type": ["integer", "null"],
|
||||
"title": "The PurchaseDate schema",
|
||||
"description": "The purchase date of the order in Epoch time.",
|
||||
"default": 0,
|
||||
"examples": [
|
||||
1595882000633
|
||||
]
|
||||
},
|
||||
"OrderStatus": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/OrderStatus",
|
||||
"type": "string",
|
||||
"title": "The OrderStatus schema",
|
||||
"description": "The current order status. The possible values include UpComing, Pending, Unshipped, PartiallyShipped, PendingAvailability, Canceled, InvoiceUnconfirmed, Shipped, and Unfulfillable.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"Unshipped"
|
||||
]
|
||||
},
|
||||
"DestinationPostalCode": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/DestinationPostalCode",
|
||||
"type": ["string", "null"],
|
||||
"title": "The DestinationPostalCode schema",
|
||||
"description": "The destination postal code.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"48110"
|
||||
]
|
||||
},
|
||||
"SupplySourceId": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/SupplySourceId",
|
||||
"type": ["string", "null"],
|
||||
"title": "The SupplySourceId schema",
|
||||
"description": "The unique identifier of the supply source.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"55448834-0d79-5155-75c4-8529543a7c31"
|
||||
]
|
||||
},
|
||||
"OrderItemId": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/OrderItemId",
|
||||
"type": "string",
|
||||
"title": "The OrderItemId schema",
|
||||
"description": "The Amazon-defined order item identifier.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"OIID34853450"
|
||||
]
|
||||
},
|
||||
"SellerSKU": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/SellerSKU",
|
||||
"type": "string",
|
||||
"title": "The SellerSKU schema",
|
||||
"description": "The seller-specific SKU identifier for an item.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"SellerSKUID1"
|
||||
]
|
||||
},
|
||||
"Quantity": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/Quantity",
|
||||
"type": "integer",
|
||||
"title": "The Quantity schema",
|
||||
"description": "The number of items in the order.",
|
||||
"default": 0,
|
||||
"examples": [
|
||||
45
|
||||
]
|
||||
},
|
||||
"FulfillmentChannel": {
|
||||
"$id": "#/properties/Payload/properties/OrderStatusChangeNotification/properties/FulfillmentChannel",
|
||||
"type": "string",
|
||||
"title": "The FulfillmentChannel schema",
|
||||
"description": "Fulfillment channel of the affected order, MFN or AFN.",
|
||||
"examples": [
|
||||
"MFN"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"$id": "#/properties/NotificationMetadata",
|
||||
"type": "object",
|
||||
"title": "The NotificationMetadata schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
|
||||
"PublishTime": "2020-07-13T19:42:04.284Z",
|
||||
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"ApplicationId",
|
||||
"SubscriptionId",
|
||||
"PublishTime",
|
||||
"NotificationId"
|
||||
],
|
||||
"properties": {
|
||||
"ApplicationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/ApplicationId",
|
||||
"type": "string",
|
||||
"title": "The ApplicationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
},
|
||||
"SubscriptionId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/SubscriptionId",
|
||||
"type": "string",
|
||||
"title": "The SubscriptionId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
},
|
||||
"PublishTime": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/PublishTime",
|
||||
"type": "string",
|
||||
"title": "The PublishTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"NotificationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/NotificationId",
|
||||
"type": "string",
|
||||
"title": "The NotificationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
|
|
@ -0,0 +1,467 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"type": "object",
|
||||
"description": "The notification response schema that comprises the entire JSON document for PRICING_HEALTH notification",
|
||||
"examples": [
|
||||
{
|
||||
"notificationVersion": "1.0",
|
||||
"notificationType": "PRICING_HEALTH",
|
||||
"payloadVersion": "1.0",
|
||||
"eventTime": "2020-09-23T21:30:13.713Z",
|
||||
"payload": {
|
||||
"issueType": "BuyBoxDisqualification",
|
||||
"sellerId": "A3EZFOFNDPFB8R",
|
||||
"offerChangeTrigger": {
|
||||
"marketplaceId": "ATVPDKIKX0DER",
|
||||
"asin": "B007IBIWZY",
|
||||
"itemCondition": "new",
|
||||
"timeOfOfferChange": "2020-09-23T21:30:13.409Z"
|
||||
},
|
||||
"merchantOffer": {
|
||||
"condition": "new",
|
||||
"fulfillmentType": "MFN",
|
||||
"listingPrice": {
|
||||
"amount": 8184.23,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shipping": {
|
||||
"amount": 4.49,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"landedPrice": {
|
||||
"amount": 8188.72,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"points" : {
|
||||
"pointsNumber" : 34343
|
||||
}
|
||||
},
|
||||
"summary": {
|
||||
"numberOfOffers": [
|
||||
{
|
||||
"condition": "new",
|
||||
"fulfillmentType": "MFN",
|
||||
"offerCount": 3
|
||||
}
|
||||
],
|
||||
"buyBoxEligibleOffers": [
|
||||
{
|
||||
"condition": "new",
|
||||
"fulfillmentType": "MFN",
|
||||
"offerCount": 3
|
||||
}
|
||||
],
|
||||
"buyBoxPrices": [
|
||||
{
|
||||
"condition": "new",
|
||||
"listingPrice": {
|
||||
"amount": 8184.23,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shipping": {
|
||||
"amount": 4.49,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"landedPrice": {
|
||||
"amount": 8188.72,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"points" : {
|
||||
"pointsNumber" : 34343
|
||||
}
|
||||
}
|
||||
],
|
||||
"salesRankings": [
|
||||
{
|
||||
"productCategoryId": "lawn_and_garden_display_on_website",
|
||||
"rank": 4013
|
||||
},
|
||||
{
|
||||
"productCategoryId": "home_garden_display_on_website",
|
||||
"rank": 17316
|
||||
}
|
||||
],
|
||||
"referencePrice": {
|
||||
"averageSellingPrice": {
|
||||
"amount": 7500,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"competitivePriceThreshold": {
|
||||
"amount": 8000,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"msrpPrice": {
|
||||
"amount": 7900,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"retailOfferPrice": {
|
||||
"amount": 8000,
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"notificationMetadata": {
|
||||
"applicationId": "amzn1.sellerapps.app.1da85d14-a68d-4ff3-9ff0-df6429e00d9a",
|
||||
"subscriptionId": "e3a059ca-677a-442a-8d39-05b2848971b6",
|
||||
"publishTime": "2020-09-23T21:30:16.903Z",
|
||||
"notificationId": "23ae41cd-3537-4676-af46-6ee9abf8802e"
|
||||
}
|
||||
}
|
||||
],
|
||||
"$ref": "#/definitions/notificationResponse",
|
||||
"definitions": {
|
||||
"offerChangeTrigger": {
|
||||
"type": "object",
|
||||
"description": "The event that caused the notification to be sent",
|
||||
"required": [
|
||||
"marketplaceId",
|
||||
"asin",
|
||||
"itemCondition",
|
||||
"timeOfOfferChange"
|
||||
],
|
||||
"properties": {
|
||||
"marketplaceId": {
|
||||
"type": "string",
|
||||
"description": "The marketplace identifier of the item that had an offer change"
|
||||
},
|
||||
"asin": {
|
||||
"type": "string",
|
||||
"description": "The asin for the item that had an offer change"
|
||||
},
|
||||
"itemCondition": {
|
||||
"type": "string",
|
||||
"description": "The condition of the item that had an offer change"
|
||||
},
|
||||
"timeOfOfferChange": {
|
||||
"type": "string",
|
||||
"description": "The update time for the offer that caused this notification"
|
||||
}
|
||||
}
|
||||
},
|
||||
"condition": {
|
||||
"type": "string",
|
||||
"description": "Indicates the condition of the item"
|
||||
},
|
||||
"fulfillmentType": {
|
||||
"type": "string",
|
||||
"description": "Indicates whether the item is fulfilled by Amazon or by the seller",
|
||||
"enum": [
|
||||
"AFN",
|
||||
"MFN"
|
||||
]
|
||||
},
|
||||
"offerCount": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"condition",
|
||||
"fulfillmentType",
|
||||
"offerCount"
|
||||
],
|
||||
"properties": {
|
||||
"condition": {
|
||||
"$ref": "#/definitions/condition"
|
||||
},
|
||||
"fulfillmentType": {
|
||||
"$ref": "#/definitions/fulfillmentType"
|
||||
},
|
||||
"offerCount": {
|
||||
"type": "integer",
|
||||
"description": "The total number of offers for the specified condition and fulfillment channel"
|
||||
}
|
||||
}
|
||||
},
|
||||
"moneyType": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"amount",
|
||||
"currencyCode"
|
||||
],
|
||||
"properties": {
|
||||
"amount": {
|
||||
"type": "number"
|
||||
},
|
||||
"currencyCode": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"landedPrice": {
|
||||
"$ref": "#/definitions/moneyType",
|
||||
"description": "ListingPrice + Shipping"
|
||||
},
|
||||
"listingPrice": {
|
||||
"$ref": "#/definitions/moneyType",
|
||||
"description": "The price of the item"
|
||||
},
|
||||
"shipping": {
|
||||
"$ref": "#/definitions/moneyType",
|
||||
"description": "The shipping cost"
|
||||
},
|
||||
"points": {
|
||||
"type": "object",
|
||||
"description": "The number of Amazon Points offered with the purchase of an item",
|
||||
"required": [
|
||||
"pointsNumber"
|
||||
],
|
||||
"properties": {
|
||||
"pointsNumber": {
|
||||
"type": "integer",
|
||||
"description": "The number of Amazon Points offered with the purchase of an item"
|
||||
}
|
||||
}
|
||||
},
|
||||
"merchantOffer": {
|
||||
"type": "object",
|
||||
"description": "Offer details of the merchant receiving the notification",
|
||||
"required": [
|
||||
"condition",
|
||||
"fulfillmentType",
|
||||
"landedPrice",
|
||||
"shipping",
|
||||
"listingPrice"
|
||||
],
|
||||
"properties": {
|
||||
"condition": {
|
||||
"$ref": "#/definitions/condition"
|
||||
},
|
||||
"fulfillmentType": {
|
||||
"$ref": "#/definitions/fulfillmentType"
|
||||
},
|
||||
"landedPrice": {
|
||||
"$ref": "#/definitions/landedPrice"
|
||||
},
|
||||
"listingPrice": {
|
||||
"$ref": "#/definitions/listingPrice"
|
||||
},
|
||||
"shipping": {
|
||||
"$ref": "#/definitions/shipping"
|
||||
},
|
||||
"points": {
|
||||
"$ref": "#/definitions/points"
|
||||
}
|
||||
}
|
||||
},
|
||||
"buyBoxPrice": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"condition",
|
||||
"landedPrice",
|
||||
"shipping",
|
||||
"listingPrice"
|
||||
],
|
||||
"properties": {
|
||||
"condition": {
|
||||
"$ref": "#/definitions/condition"
|
||||
},
|
||||
"landedPrice": {
|
||||
"$ref": "#/definitions/landedPrice"
|
||||
},
|
||||
"listingPrice": {
|
||||
"$ref": "#/definitions/listingPrice"
|
||||
},
|
||||
"shipping": {
|
||||
"$ref": "#/definitions/shipping"
|
||||
},
|
||||
"points": {
|
||||
"$ref": "#/definitions/points"
|
||||
}
|
||||
}
|
||||
},
|
||||
"salesRank": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"productCategoryId",
|
||||
"rank"
|
||||
],
|
||||
"properties": {
|
||||
"productCategoryId": {
|
||||
"type": "string",
|
||||
"description": "The product category for the rank"
|
||||
},
|
||||
"rank": {
|
||||
"type": "integer",
|
||||
"description": "The sales rank of the ASIN"
|
||||
}
|
||||
}
|
||||
},
|
||||
"averageSellingPrice": {
|
||||
"$ref": "#/definitions/moneyType",
|
||||
"description": "The average selling price of the item"
|
||||
},
|
||||
"competitivePriceThreshold": {
|
||||
"$ref": "#/definitions/moneyType",
|
||||
"description": "The competitive price threshold from external competitors of Amazon"
|
||||
},
|
||||
"retailOfferPrice": {
|
||||
"$ref": "#/definitions/moneyType",
|
||||
"description": "The 14 day maximum of retail offer price"
|
||||
},
|
||||
"msrpPrice": {
|
||||
"$ref": "#/definitions/moneyType",
|
||||
"description": "The manufacturer suggested retail price for the ASIN"
|
||||
},
|
||||
"referencePrice": {
|
||||
"type": "object",
|
||||
"description": "A set of reference prices for the given ASIN",
|
||||
"properties": {
|
||||
"averageSellingPrice": {
|
||||
"$ref": "#/definitions/averageSellingPrice"
|
||||
},
|
||||
"competitivePriceThreshold": {
|
||||
"$ref": "#/definitions/competitivePriceThreshold"
|
||||
},
|
||||
"retailOfferPrice": {
|
||||
"$ref": "#/definitions/retailOfferPrice"
|
||||
},
|
||||
"msrpPrice": {
|
||||
"$ref": "#/definitions/msrpPrice"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"numberOfOffers",
|
||||
"buyBoxEligibleOffers",
|
||||
"referencePrice"
|
||||
],
|
||||
"properties": {
|
||||
"numberOfOffers": {
|
||||
"type": "array",
|
||||
"description": "A list that contains the total number of offers for the item for the given conditions and fulfillment channels",
|
||||
"additionalItems": true,
|
||||
"items": [
|
||||
{
|
||||
"$ref": "#/definitions/offerCount"
|
||||
}
|
||||
]
|
||||
},
|
||||
"buyBoxEligibleOffers": {
|
||||
"type": "array",
|
||||
"description": "A list that contains the total number of offers that are eligible for the Buy Box for the given conditions and fulfillment channels",
|
||||
"additionalItems": true,
|
||||
"items": [
|
||||
{
|
||||
"$ref": "#/definitions/offerCount"
|
||||
}
|
||||
]
|
||||
},
|
||||
"buyBoxPrices": {
|
||||
"type": "array",
|
||||
"description": "A list that contains the Buy Box price of the item for the given conditions",
|
||||
"additionalItems": true,
|
||||
"items": [
|
||||
{
|
||||
"$ref": "#/definitions/buyBoxPrice"
|
||||
}
|
||||
]
|
||||
},
|
||||
"salesRankings": {
|
||||
"type": "array",
|
||||
"description": "A list that contains the sales rankings of the asin in various product categories",
|
||||
"additionalItems": true,
|
||||
"items": [
|
||||
{
|
||||
"$ref": "#/definitions/salesRank"
|
||||
}
|
||||
]
|
||||
},
|
||||
"referencePrice": {
|
||||
"$ref": "#/definitions/referencePrice"
|
||||
}
|
||||
}
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"issueType",
|
||||
"sellerId",
|
||||
"offerChangeTrigger",
|
||||
"merchantOffer",
|
||||
"summary"
|
||||
],
|
||||
"properties": {
|
||||
"sellerId": {
|
||||
"type": "string",
|
||||
"description": "The seller identifier for the offer"
|
||||
},
|
||||
"issueType": {
|
||||
"type": "string",
|
||||
"description": "The issue type for the notification"
|
||||
},
|
||||
"offerChangeTrigger": {
|
||||
"$ref": "#/definitions/offerChangeTrigger"
|
||||
},
|
||||
"merchantOffer": {
|
||||
"$ref": "#/definitions/merchantOffer"
|
||||
},
|
||||
"summary": {
|
||||
"$ref": "#/definitions/summary"
|
||||
}
|
||||
}
|
||||
},
|
||||
"notificationMetadata": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"applicationId",
|
||||
"subscriptionId",
|
||||
"publishTime",
|
||||
"notificationId"
|
||||
],
|
||||
"properties": {
|
||||
"applicationId": {
|
||||
"type": "string",
|
||||
"description": "The identifier for the application that uses the notifications"
|
||||
},
|
||||
"subscriptionId": {
|
||||
"type": "string",
|
||||
"description": "A unique identifier for the subscription which resulted in this notification"
|
||||
},
|
||||
"publishTime": {
|
||||
"type": "string",
|
||||
"description": "The date and time (in UTC) that the notification was sent"
|
||||
},
|
||||
"notificationId": {
|
||||
"type": "string",
|
||||
"description": "A unique identifier for this notification instance"
|
||||
}
|
||||
}
|
||||
},
|
||||
"notificationResponse": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"notificationVersion",
|
||||
"notificationType",
|
||||
"payloadVersion",
|
||||
"eventTime",
|
||||
"payload",
|
||||
"notificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"notificationVersion": {
|
||||
"type": "string",
|
||||
"description": "The notification version. This controls the structure of the notification"
|
||||
},
|
||||
"notificationType": {
|
||||
"type": "string",
|
||||
"description": "The notification type. Combined with payload version controls the structure of payload object"
|
||||
},
|
||||
"payloadVersion": {
|
||||
"type": "string",
|
||||
"description": "The payload version. Combined with notification type controls the structure of payload"
|
||||
},
|
||||
"eventTime": {
|
||||
"type": "string",
|
||||
"description": "The date and time (in UTC) that the event which triggered the notification occurred"
|
||||
},
|
||||
"payload": {
|
||||
"$ref": "#/definitions/payload"
|
||||
},
|
||||
"notificationMetadata": {
|
||||
"$ref": "#/definitions/notificationMetadata"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,218 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "http://example.com/example.json",
|
||||
"type": "object",
|
||||
"title": "The root schema",
|
||||
"description": "The root schema comprises the entire JSON document.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"NotificationVersion":"1.0",
|
||||
"NotificationType":"PRODUCT_TYPE_DEFINITIONS_CHANGE",
|
||||
"PayloadVersion":"1.0",
|
||||
"EventTime":"2021-02-03T18:59:30.194Z",
|
||||
"Payload":{
|
||||
"AccountId": "AXXXXXXXXXXX",
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"ProductTypeVersion": "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr",
|
||||
"NewProductTypes": [
|
||||
"LUGGAGE",
|
||||
"SHOES"
|
||||
]
|
||||
},
|
||||
"NotificationMetadata":{
|
||||
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
|
||||
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime":"2021-02-03T18:59:30.194Z",
|
||||
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"NotificationVersion",
|
||||
"NotificationType",
|
||||
"PayloadVersion",
|
||||
"EventTime",
|
||||
"Payload",
|
||||
"NotificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"NotificationVersion": {
|
||||
"$id": "#/properties/NotificationVersion",
|
||||
"type": "string",
|
||||
"title": "The NotificationVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"NotificationType": {
|
||||
"$id": "#/properties/NotificationType",
|
||||
"type": "string",
|
||||
"title": "The NotificationType schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"PRODUCT_TYPE_DEFINITIONS_CHANGE"
|
||||
]
|
||||
},
|
||||
"PayloadVersion": {
|
||||
"$id": "#/properties/PayloadVersion",
|
||||
"type": "string",
|
||||
"title": "The PayloadVersion schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"1.0"
|
||||
]
|
||||
},
|
||||
"EventTime": {
|
||||
"$id": "#/properties/EventTime",
|
||||
"type": "string",
|
||||
"title": "The EventTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:30.194Z"
|
||||
]
|
||||
},
|
||||
"Payload": {
|
||||
"$id": "#/properties/Payload",
|
||||
"type": "object",
|
||||
"title": "The Payload schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"AccountId": "AXXXXXXXXXXX",
|
||||
"MarketplaceId": "ATVPDKIKX0DER",
|
||||
"ProductTypeVersion": "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr",
|
||||
"NewProductTypes": [
|
||||
"LUGGAGE",
|
||||
"SHOES"
|
||||
]
|
||||
},
|
||||
{
|
||||
"AccountId": "AXXXXXXXXXXX",
|
||||
"ProductTypeVersion": "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"AccountId",
|
||||
"ProductTypeVersion"
|
||||
],
|
||||
"properties": {
|
||||
"MarketplaceId": {
|
||||
"$id": "#/properties/Payload/properties/MarketplaceId",
|
||||
"type": "string",
|
||||
"title": "The MarketplaceId schema",
|
||||
"description": "The marketplace where the Product Type Definition has changed",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"AccountId": {
|
||||
"$id": "#/properties/Payload/properties/AccountId",
|
||||
"type": "string",
|
||||
"title": "The Merchant Id or Vendor Group Id.",
|
||||
"description": "The Merchant Id or Vendor Group Id related to the subscription.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"AXXXXXXXXXXX"
|
||||
]
|
||||
},
|
||||
"ProductTypeVersion": {
|
||||
"$id": "#/properties/Payload/properties/ProductTypeVersion",
|
||||
"type": "string",
|
||||
"title": "The version of latest Product Type Definitions",
|
||||
"description": "Provides the latest released Product Type Definition version.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr"
|
||||
]
|
||||
},
|
||||
"NewProductTypes": {
|
||||
"$id": "#/properties/Payload/properties/NewProductTypes",
|
||||
"type": "array",
|
||||
"title": "New Product Types",
|
||||
"description": "List of new Product Types release in the marketplace.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
[
|
||||
"LUGGAGE",
|
||||
"SHOES"
|
||||
]
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"$id": "#/properties/NotificationMetadata",
|
||||
"type": "object",
|
||||
"title": "The NotificationMetadata schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": {},
|
||||
"examples": [
|
||||
{
|
||||
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
|
||||
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
|
||||
"PublishTime": "2019-03-20T18:59:48.768Z",
|
||||
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"ApplicationId",
|
||||
"SubscriptionId",
|
||||
"PublishTime",
|
||||
"NotificationId"
|
||||
],
|
||||
"properties": {
|
||||
"ApplicationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/ApplicationId",
|
||||
"type": "string",
|
||||
"title": "The ApplicationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"
|
||||
]
|
||||
},
|
||||
"SubscriptionId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/SubscriptionId",
|
||||
"type": "string",
|
||||
"title": "The SubscriptionId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"93b098e1-c42-2f45-93a1-78910a6a8369"
|
||||
]
|
||||
},
|
||||
"PublishTime": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/PublishTime",
|
||||
"type": "string",
|
||||
"title": "The PublishTime schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"2019-03-20T18:59:48.768Z"
|
||||
]
|
||||
},
|
||||
"NotificationId": {
|
||||
"$id": "#/properties/NotificationMetadata/properties/NotificationId",
|
||||
"type": "string",
|
||||
"title": "The NotificationId schema",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"default": "",
|
||||
"examples": [
|
||||
"8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
|
|
@ -0,0 +1,214 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"$id": "http://example.com/example.json",
|
||||
"type": "object",
|
||||
"description": "The root schema comprises the entire JSON document.",
|
||||
"examples": [
|
||||
{
|
||||
"notificationVersion": "2020-09-04",
|
||||
"notificationType": "REPORT_PROCESSING_FINISHED",
|
||||
"payloadVersion": "2020-09-04",
|
||||
"eventTime": "2020-07-14T03:35:13.214Z",
|
||||
"payload": {
|
||||
"reportProcessingFinishedNotification": {
|
||||
"sellerId": "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"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"notificationVersion",
|
||||
"notificationType",
|
||||
"payloadVersion",
|
||||
"eventTime",
|
||||
"payload",
|
||||
"notificationMetadata"
|
||||
],
|
||||
"properties": {
|
||||
"notificationVersion": {
|
||||
"$id": "#/properties/notificationVersion",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"2020-09-04"
|
||||
]
|
||||
},
|
||||
"notificationType": {
|
||||
"$id": "#/properties/notificationType",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"REPORT_PROCESSING_FINISHED"
|
||||
]
|
||||
},
|
||||
"payloadVersion": {
|
||||
"$id": "#/properties/payloadVersion",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"2020-09-04"
|
||||
]
|
||||
},
|
||||
"eventTime": {
|
||||
"$id": "#/properties/eventTime",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"2020-07-14T03:35:13.214Z"
|
||||
]
|
||||
},
|
||||
"payload": {
|
||||
"$id": "#/properties/payload",
|
||||
"type": "object",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
{
|
||||
"reportProcessingFinishedNotification": {
|
||||
"sellerId": "A3TH9S8BH6GOGM",
|
||||
"reportId": "54517018502",
|
||||
"reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA",
|
||||
"processingStatus": "CANCELLED",
|
||||
"reportDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"
|
||||
}
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportProcessingFinishedNotification"
|
||||
],
|
||||
"properties": {
|
||||
"reportProcessingFinishedNotification": {
|
||||
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification",
|
||||
"type": "object",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
{
|
||||
"sellerId": "A3TH9S8BH6GOGM",
|
||||
"reportId": "54517018502",
|
||||
"reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA",
|
||||
"processingStatus": "CANCELLED",
|
||||
"reportDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"sellerId",
|
||||
"reportId",
|
||||
"reportType",
|
||||
"processingStatus"
|
||||
],
|
||||
"properties": {
|
||||
"sellerId": {
|
||||
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/sellerId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"A3TH9S8BH6GOGM"
|
||||
]
|
||||
},
|
||||
"reportId": {
|
||||
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"54517018502"
|
||||
]
|
||||
},
|
||||
"reportType": {
|
||||
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportType",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"
|
||||
]
|
||||
},
|
||||
"processingStatus": {
|
||||
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/processingStatus",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"CANCELLED",
|
||||
"DONE",
|
||||
"FATAL"
|
||||
],
|
||||
"enum": [
|
||||
"CANCELLED",
|
||||
"DONE",
|
||||
"FATAL"
|
||||
]
|
||||
},
|
||||
"reportDocumentId": {
|
||||
"$id": "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportDocumentId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"notificationMetadata": {
|
||||
"$id": "#/properties/notificationMetadata",
|
||||
"type": "object",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
{
|
||||
"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"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"applicationId",
|
||||
"subscriptionId",
|
||||
"publishTime",
|
||||
"notificationId"
|
||||
],
|
||||
"properties": {
|
||||
"applicationId": {
|
||||
"$id": "#/properties/notificationMetadata/properties/applicationId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"
|
||||
]
|
||||
},
|
||||
"subscriptionId": {
|
||||
"$id": "#/properties/notificationMetadata/properties/subscriptionId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
},
|
||||
"publishTime": {
|
||||
"$id": "#/properties/notificationMetadata/properties/publishTime",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"2020-07-13T19:42:04.284Z"
|
||||
]
|
||||
},
|
||||
"notificationId": {
|
||||
"$id": "#/properties/notificationMetadata/properties/notificationId",
|
||||
"type": "string",
|
||||
"description": "An explanation about the purpose of this instance.",
|
||||
"examples": [
|
||||
"d0e9e693-c3ad-4373-979f-ed4ec98dd746"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue