Variable transactionUpdateNotificationConst

Type declaration

• Readonly$id: "http://example.com/example.json"

• Readonlydescription: "The notification response schema that comprises the entire JSON document for the notification."

• Readonlyexamples: readonly [
      {
          EventTime: "2023-07-14T03:35:13.214Z";
          NotificationMetadata: {
              ApplicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336";
              NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
              PublishTime: "2023-07-14T03:35:13.214Z";
              SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
          };
          NotificationType: "TRANSACTION_UPDATE";
          NotificationVersion: "1.0";
          Payload: {
              TransactionUpdateNotification: {
                  PostedDate: "2023-07-14T03:35:13.214Z";
                  RelatedIdentifiers: readonly [
                      {
                          RelatedIdentifierName: "OrderId";
                          RelatedIdentifierValue: "8129762527551";
                      },
                  ];
                  SellingPartnerMetadata: {
                      AccountType: "PAYABLE";
                      MarketplaceId: "ATIV93840DER";
                      SellingPartnerId: "A3TH9S8BH6GOGM";
                  };
                  TotalAmount: { CurrencyAmount: 10; CurrencyCode: "USD" };
                  TransactionType: "Shipment";
              };
          };
          PayloadVersion: "1.0";
      },
  ]

• Readonlyproperties: {
      EventTime: {
          $id: "#/properties/EventTime";
          description: "The time when this notification was published, presented in ISO-8601 date/time format.";
          examples: readonly ["2023-07-14T03:35:13.214Z"];
          title: "The EventTime schema";
          type: "string";
      };
      NotificationMetadata: {
          $id: "#/properties/NotificationMetadata";
          description: "The notification metadata.";
          examples: readonly [
              {
                  ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                  NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                  PublishTime: "2023-07-13T19:42:04.284Z";
                  SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
              },
          ];
          properties: {
              ApplicationId: {
                  $id: "#/properties/NotificationMetadata/properties/ApplicationId";
                  description: "The identifier for the application that uses the notifications.";
                  examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                  title: "The ApplicationId schema";
                  type: "string";
              };
              NotificationId: {
                  $id: "#/properties/NotificationMetadata/properties/NotificationId";
                  description: "A unique identifier for this notification instance.";
                  examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                  title: "The NotificationId schema";
                  type: "string";
              };
              PublishTime: {
                  $id: "#/properties/NotificationMetadata/properties/PublishTime";
                  description: "The date and time (in UTC) that the notification was sent, presented in ISO-8601 date/time format.";
                  examples: readonly ["2023-07-14T19:42:04.284Z"];
                  title: "The PublishTime schema";
                  type: "string";
              };
              SubscriptionId: {
                  $id: "#/properties/NotificationMetadata/properties/SubscriptionId";
                  description: "A unique identifier for the subscription which resulted in this notification.";
                  examples: readonly [
                      "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
                  ];
                  title: "The SubscriptionId schema";
                  type: "string";
              };
          };
          required: readonly [
              "ApplicationId",
              "SubscriptionId",
              "PublishTime",
              "NotificationId",
          ];
          title: "The NotificationMetadata schema";
          type: "object";
      };
      NotificationType: {
          $id: "#/properties/NotificationType";
          description: "The type of this notification, used to differentiate different notifications. Combined with payload version controls the structure of payload object.";
          examples: readonly ["TRANSACTION_UPDATE"];
          title: "The NotificationType schema";
          type: "string";
      };
      NotificationVersion: {
          $id: "#/properties/NotificationVersion";
          description: "The notification version.";
          examples: readonly ["1.0"];
          title: "The NotificationVersion schema";
          type: "string";
      };
      Payload: {
          $id: "#/properties/Payload";
          description: "The payload for this TRANSACTION_UPDATE notification. It's unique for different event type and will provide more in-depth information about this notification.";
          examples: readonly [
              {
                  TransactionUpdateNotification: {
                      PostedDate: "2023-07-14T03:35:13.214Z";
                      RelatedIdentifiers: readonly [
                          {
                              RelatedIdentifierName: "OrderId";
                              RelatedIdentifierValue: "8129762527551";
                          },
                      ];
                      SellingPartnerMetadata: {
                          AccountType: "PAYABLE";
                          MarketplaceId: "ATIV93840DER";
                          SellingPartnerId: "A3TH9S8BH6GOGM";
                      };
                      TotalAmount: { CurrencyAmount: 10; CurrencyCode: "USD" };
                      TransactionType: "Shipment";
                  };
              },
          ];
          properties: {
              TransactionUpdateNotification: {
                  $id: "#/properties/Payload/properties/TransactionUpdateNotification";
                  description: "An explanation about the TRANSACTION_UPDATE notification.";
                  examples: readonly [
                      {
                          PostedDate: "2023-07-14T03:35:13.214Z";
                          RelatedIdentifiers: readonly [
                              {
                                  RelatedIdentifierName: "OrderId";
                                  RelatedIdentifierValue: "8129762527551";
                              },
                          ];
                          SellingPartnerMetadata: {
                              AccountType: "PAYABLE";
                              MarketplaceId: "ATIV93840DER";
                              SellingPartnerId: "A3TH9S8BH6GOGM";
                          };
                          TotalAmount: { CurrencyAmount: 10; CurrencyCode: "USD" };
                          TransactionType: "Shipment";
                      },
                  ];
                  properties: {
                      PostedDate: {
                          $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/PostedDate";
                          description: "The date and time when the transaction was posted.";
                          examples: readonly ["2023-07-14T03:35:13.214Z"];
                          type: "string";
                      };
                      RelatedIdentifiers: {
                          $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/RelatedIdentifiers";
                          description: "Related business identifiers of the transaction.";
                          examples: readonly [
                              readonly [
                                  {
                                      RelatedIdentifierName: "OrderId";
                                      RelatedIdentifierValue: "8129762527551";
                                  },
                              ],
                          ];
                          items: {
                              description: "Related business identifier of the transaction.";
                              examples: readonly [
                                  {
                                      RelatedIdentifierName: "OrderId";
                                      RelatedIdentifierValue: "8129762527551";
                                  },
                              ];
                              properties: {
                                  RelatedIdentifierName: {
                                      $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/RelatedIdentifiers/RelatedIdentifierName";
                                      description: "Enumerated set of related business identifier names.";
                                      examples: readonly [(...)];
                                      type: "string";
                                  };
                                  RelatedIdentifierValue: {
                                      $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/RelatedIdentifiers/RelatedIdentifierValue";
                                      description: "Corresponding value of RelatedIdentifierName";
                                      examples: readonly [(...)];
                                      type: "string";
                                  };
                              };
                              required: readonly [
                                  "RelatedIdentifierName",
                                  "RelatedIdentifierValue",
                              ];
                              type: "object";
                          };
                          type: "array";
                      };
                      SellingPartnerMetadata: {
                          $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/SellingPartnerMetadata";
                          description: "Metadata describing the seller.";
                          examples: readonly [
                              {
                                  AccountType: "PAYABLE";
                                  MarketplaceId: "ATIV93840DER";
                                  SellingPartnerId: "A3TH9S8BH6GOGM";
                              },
                          ];
                          properties: {
                              AccountType: {
                                  $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/SellingPartnerMetadata/properties/AccountType";
                                  description: "Account type of transaction.";
                                  examples: readonly ["PAYABLE"];
                                  type: "string";
                              };
                              MarketplaceId: {
                                  $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/SellingPartnerMetadata/properties/MarketplaceId";
                                  description: "Marketplace identifier of transaction.";
                                  examples: readonly ["ATIV93840DER"];
                                  type: "string";
                              };
                              SellingPartnerId: {
                                  $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/SellingPartnerMetadata/properties/SellingPartnerId";
                                  description: "Unique seller identifier.";
                                  examples: readonly ["A3TH9S8BH6GOGM"];
                                  type: "string";
                              };
                          };
                          required: readonly [
                              "SellingPartnerId",
                              "MarketplaceId",
                              "AccountType",
                          ];
                          type: "object";
                      };
                      TotalAmount: {
                          $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/TotalAmount";
                          description: "Total amount of transaction.";
                          examples: readonly [{ CurrencyAmount: 10; CurrencyCode: "USD" }];
                          properties: {
                              CurrencyAmount: {
                                  $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/TotalAmount/properties/CurrencyAmount";
                                  description: "Amount value of transaction.";
                                  examples: readonly [10];
                                  type: "number";
                              };
                              CurrencyCode: {
                                  $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/TotalAmount/properties/CurrencyCode";
                                  description: "Currency code of transaction.";
                                  examples: readonly ["USD"];
                                  type: "string";
                              };
                          };
                          required: readonly ["CurrencyAmount", "CurrencyCode"];
                          type: "object";
                      };
                      TransactionType: {
                          $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/TransactionType";
                          description: "Type of transaction.";
                          examples: readonly ["Shipment"];
                          type: "string";
                      };
                  };
                  required: readonly [
                      "SellingPartnerMetadata",
                      "TransactionType",
                      "PostedDate",
                      "TotalAmount",
                  ];
                  title: "The TransactionUpdateNotification schema";
                  type: "object";
              };
          };
          required: readonly ["TransactionUpdateNotification"];
          title: "The Payload schema";
          type: "object";
      };
      PayloadVersion: {
          $id: "#/properties/PayloadVersion";
          description: "The payload version of the notification.";
          examples: readonly ["1.0"];
          title: "The PayloadVersion schema";
          type: "string";
      };
  }

• Readonlyrequired: readonly [
      "NotificationVersion",
      "NotificationType",
      "PayloadVersion",
      "EventTime",
      "Payload",
      "NotificationMetadata",
  ]

• Readonlytitle: "The root schema"

• Readonlytype: "object"