Variable orderChangeNotificationConst

Type declaration

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

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

• Readonlyexamples: readonly [
      {
          EventTime: "2020-01-11T00:09:53.109Z";
          NotificationMetadata: {
              ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
              NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
              PublishTime: "2020-07-13T19:42:04.284Z";
              SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
          };
          NotificationType: "ORDER_CHANGE";
          NotificationVersion: "1.0";
          Payload: {
              OrderChangeNotification: {
                  AmazonOrderId: "903-8868176-2219830";
                  NotificationLevel: "OrderLevel";
                  OrderChangeTrigger: {
                      ChangeReason: "Buyer Requested Cancel";
                      TimeOfOrderChange: "2022-11-29T19:42:04.284Z";
                  };
                  OrderChangeType: "BuyerRequestedChange";
                  SellerId: "A3TH9S8BH6GOGM";
                  Summary: {
                      CancelNotifyDate: "2022-12-07T19:42:04.284Z";
                      DestinationPostalCode: "48110";
                      EarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
                      EarliestShipDate: "2022-11-07T19:42:04.284Z";
                      EasyShipShipmentStatus: "Delivered";
                      ElectronicInvoiceStatus: "NotFound";
                      FulfillmentType: "MFN";
                      LatestDeliveryDate: "2022-12-07T19:42:04.284Z";
                      LatestShipDate: "2022-12-07T19:42:04.284Z";
                      MarketplaceId: "ATVPDKIKX0DER";
                      NumberOfItemsShipped: 0;
                      NumberOfItemsUnshipped: 10;
                      OrderItems: readonly [
                          {
                              IsBuyerRequestedCancel: true;
                              ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
                              ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z";
                              OrderItemId: "OIID34853450";
                              OrderItemStatus: "Unshipped";
                              Quantity: 10;
                              QuantityShipped: 0;
                              SellerSKU: "SellerSKUID1";
                              SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3";
                          },
                      ];
                      OrderPrograms: readonly ["Business"];
                      OrderStatus: "Unshipped";
                      OrderType: "StandardOrder";
                      PurchaseDate: "2022-07-13T19:42:04.284Z";
                      ShippingPrograms: readonly ["EasyShip"];
                  };
              };
          };
          PayloadVersion: "1.0";
      },
  ]

• Readonlyproperties: {
      EventTime: {
          $id: "#/properties/EventTime";
          description: "The time when this notification was published, in ISO-8601 date/time format.";
          examples: readonly ["2020-01-11T00:09:53.109Z"];
          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: "2020-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, in ISO-8601 date/time format.";
                  examples: readonly ["2020-07-13T19: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, this controls the structure of the payload object.";
          examples: readonly ["ORDER_CHANGE"];
          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 the ORDER_CHANGE notification.";
          examples: readonly [
              {
                  OrderChangeNotification: {
                      AmazonOrderId: "903-8868176-2219830";
                      NotificationLevel: "OrderLevel";
                      OrderChangeTrigger: {
                          ChangeReason: "Buyer Requested Cancel";
                          TimeOfOrderChange: "2022-11-29T19:42:04.284Z";
                      };
                      OrderChangeType: "BuyerRequestedChange";
                      SellerId: "A3TH9S8BH6GOGM";
                      Summary: {
                          CancelNotifyDate: "2022-12-07T19:42:04.284Z";
                          DestinationPostalCode: "48110";
                          EarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
                          EarliestShipDate: "2022-11-07T19:42:04.284Z";
                          EasyShipShipmentStatus: "Delivered";
                          ElectronicInvoiceStatus: "NotFound";
                          FulfillmentType: "MFN";
                          LatestDeliveryDate: "2022-12-07T19:42:04.284Z";
                          LatestShipDate: "2022-12-07T19:42:04.284Z";
                          MarketplaceId: "ATVPDKIKX0DER";
                          NumberOfItemsShipped: 0;
                          NumberOfItemsUnshipped: 10;
                          OrderItems: readonly [
                              {
                                  IsBuyerRequestedCancel: true;
                                  ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
                                  ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z";
                                  OrderItemId: "OIID34853450";
                                  OrderItemStatus: "Unshipped";
                                  Quantity: 10;
                                  QuantityShipped: 0;
                                  SellerSKU: "SellerSKUID1";
                                  SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3";
                              },
                          ];
                          OrderPrograms: readonly ["Business"];
                          OrderStatus: "Unshipped";
                          OrderType: "StandardOrder";
                          PurchaseDate: "2022-07-13T19:42:04.284Z";
                          ShippingPrograms: readonly ["EasyShip"];
                      };
                  };
              },
          ];
          properties: {
              OrderChangeNotification: {
                  $id: "#/properties/Payload/properties/OrderChangeNotification";
                  description: "An explanation about the ORDER_CHANGE notification.";
                  examples: readonly [
                      {
                          AmazonOrderId: "903-8868176-2219830";
                          NotificationLevel: "OrderLevel";
                          OrderChangeTrigger: {
                              ChangeReason: "Buyer Requested Cancel";
                              TimeOfOrderChange: "2022-11-29T19:42:04.284Z";
                          };
                          OrderChangeType: "BuyerRequestedChange";
                          SellerId: "A3TH9S8BH6GOGM";
                          Summary: {
                              CancelNotifyDate: "2022-12-07T19:42:04.284Z";
                              DestinationPostalCode: "48110";
                              EarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
                              EarliestShipDate: "2022-11-07T19:42:04.284Z";
                              EasyShipShipmentStatus: "Delivered";
                              ElectronicInvoiceStatus: "NotFound";
                              FulfillmentType: "MFN";
                              LatestDeliveryDate: "2022-12-07T19:42:04.284Z";
                              LatestShipDate: "2022-12-07T19:42:04.284Z";
                              MarketplaceId: "ATVPDKIKX0DER";
                              NumberOfItemsShipped: 0;
                              NumberOfItemsUnshipped: 10;
                              OrderItems: readonly [
                                  {
                                      IsBuyerRequestedCancel: true;
                                      ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
                                      ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z";
                                      OrderItemId: "OIID34853450";
                                      OrderItemStatus: "Unshipped";
                                      Quantity: 10;
                                      QuantityShipped: 0;
                                      SellerSKU: "SellerSKUID1";
                                      SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3";
                                  },
                              ];
                              OrderPrograms: readonly ["Business"];
                              OrderStatus: "Unshipped";
                              OrderType: "StandardOrder";
                              PurchaseDate: "2022-07-13T19:42:04.284Z";
                              ShippingPrograms: readonly ["EasyShip"];
                          };
                      },
                  ];
                  properties: {
                      AmazonOrderId: {
                          $id: "#/properties/Payload/properties/OrderChangeNotification/properties/AmazonOrderId";
                          description: "The Amazon order identifier, in 3-7-7 format.";
                          examples: readonly ["903-8868176-2219830"];
                          title: "The AmazonOrderId schema";
                          type: "string";
                      };
                      NotificationLevel: {
                          $id: "#/properties/Payload/properties/OrderChangeNotification/properties/NotificationLevel";
                          description: "The notification level of current notification.";
                          enum: readonly ["OrderItemLevel", "OrderLevel"];
                          examples: readonly ["OrderLevel"];
                          title: "The NotificationLevel schema";
                          type: "string";
                      };
                      OrderChangeTrigger: {
                          $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeTrigger";
                          description: "Details about what caused this ORDER_CHANGE notification to be sent.";
                          examples: readonly [
                              {
                                  ChangeReason: "Buyer Requested Cancel";
                                  TimeOfOrderChange: "2022-11-29T19:42:04.284Z";
                              },
                          ];
                          properties: {
                              ChangeReason: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeTrigger/properties/ChangeReason";
                                  description: "The reason this ORDER_CHANGE notification was sent.";
                                  examples: readonly ["Buyer Requested Cancel"];
                                  title: "The ChangeReason schema";
                                  type: "string";
                              };
                              TimeOfOrderChange: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeTrigger/properties/TimeOfOrderChange";
                                  description: "The time of the change that caused this notification, in ISO-8601 date/time format. Will be null when there is no related timestamp.";
                                  examples: readonly ["2022-11-29T19:42:04.284Z"];
                                  title: "The TimeOfOrderChange schema";
                                  type: readonly ["string", "null"];
                              };
                          };
                          required: readonly ["TimeOfOrderChange", "ChangeReason"];
                          title: "The OrderChangeTrigger schema";
                          type: "object";
                      };
                      OrderChangeType: {
                          $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeType";
                          description: "The type of order change that caused the notification to be sent. Possible values are BuyerRequestedChange and OrderStatusChange.";
                          enum: readonly ["BuyerRequestedChange", "OrderStatusChange"];
                          examples: readonly ["BuyerRequestedChange"];
                          title: "The OrderChangeType schema";
                          type: "string";
                      };
                      SellerId: {
                          $id: "#/properties/Payload/properties/OrderChangeNotification/properties/SellerId";
                          description: "The selling partner identifier.";
                          examples: readonly ["AXXXXXXXXXXXXX"];
                          title: "The SellerId schema";
                          type: "string";
                      };
                      Summary: {
                          $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary";
                          description: "Information about the order and order items that had the change.";
                          examples: readonly [
                              {
                                  CancelNotifyDate: "2022-12-07T19:42:04.284Z";
                                  DestinationPostalCode: "48110";
                                  EarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
                                  EarliestShipDate: "2022-11-07T19:42:04.284Z";
                                  EasyShipShipmentStatus: "Delivered";
                                  ElectronicInvoiceStatus: "NotFound";
                                  FulfillmentType: "MFN";
                                  LatestDeliveryDate: "2022-12-07T19:42:04.284Z";
                                  LatestShipDate: "2022-12-07T19:42:04.284Z";
                                  MarketplaceId: "ATVPDKIKX0DER";
                                  NumberOfItemsShipped: 0;
                                  NumberOfItemsUnshipped: 10;
                                  OrderItems: readonly [
                                      {
                                          IsBuyerRequestedCancel: ...;
                                          ItemEarliestDeliveryDate: ...;
                                          ItemLatestDeliveryDate: ...;
                                          OrderItemId: ...;
                                          OrderItemStatus: ...;
                                          Quantity: ...;
                                          QuantityShipped: ...;
                                          SellerSKU: ...;
                                      },
                                  ];
                                  OrderPrograms: readonly ["Business"];
                                  OrderStatus: "Unshipped";
                                  OrderType: "StandardOrder";
                                  PurchaseDate: "2022-07-13T19:42:04.284Z";
                                  ShippingPrograms: readonly ["EasyShip"];
                              },
                          ];
                          properties: {
                              CancelNotifyDate: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/CancelNotifyDate";
                                  description: "The end of the time period during which you must notify the seller of possible cancellation, in ISO-8601 date/time format.";
                                  examples: readonly ["2022-12-07T19:42:04.284Z"];
                                  title: "The CancelNotifyDate schema";
                                  type: "string";
                              };
                              DestinationPostalCode: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/DestinationPostalCode";
                                  description: "The destination postal code. It will be null when there is no related information.";
                                  examples: readonly ["48110"];
                                  title: "The DestinationPostalCode schema";
                                  type: readonly ["string", "null"];
                              };
                              EarliestDeliveryDate: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/EarliestDeliveryDate";
                                  description: "The start of the time period during which you committed to fulfill the order, in ISO-8601 date/time format. Returned only for seller-fulfilled orders.";
                                  examples: readonly ["2022-11-07T19:42:04.284Z"];
                                  title: "The EarliestDeliveryDate schema";
                                  type: "string";
                              };
                              EarliestShipDate: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/EarliestShipDate";
                                  description: "The start of the time period during which you committed to ship the order, in ISO-8601 date/time format.";
                                  examples: readonly ["2022-11-07T19:42:04.284Z"];
                                  title: "The EarliestShipDate schema";
                                  type: "string";
                              };
                              EasyShipShipmentStatus: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/EasyShipShipmentStatus";
                                  description: "The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.";
                                  enum: readonly [
                                      "PendingSchedule",
                                      "PendingPickUp",
                                      "PendingDropOff",
                                      "LabelCanceled",
                                      "PickedUp",
                                      "DroppedOff",
                                      "AtOriginFC",
                                      "AtDestinationFC",
                                      "Delivered",
                                      "RejectedByBuyer",
                                      "Undeliverable",
                                      "ReturningToSeller",
                                      "ReturnedToSeller",
                                      "Lost",
                                      "OutForDelivery",
                                      "Damaged",
                                  ];
                                  examples: readonly ["Delivered"];
                                  title: "The EasyShipShipmentStatus schema";
                                  type: "string";
                              };
                              ElectronicInvoiceStatus: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/ElectronicInvoiceStatus";
                                  description: "The status of the electronic invoice.";
                                  enum: readonly [
                                      "NotRequired",
                                      "NotFound",
                                      "Processing",
                                      "Errored",
                                      "Accepted",
                                  ];
                                  examples: readonly ["NotFound"];
                                  title: "The ElectronicInvoiceStatus schema";
                                  type: "string";
                              };
                              FulfillmentType: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/FulfillmentType";
                                  description: "Fulfillment type of the affected order, MFN or AFN.";
                                  enum: readonly ["AFN", "MFN"];
                                  examples: readonly ["MFN"];
                                  title: "The FulfillmentType schema";
                                  type: "string";
                              };
                              LatestDeliveryDate: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/LatestDeliveryDate";
                                  description: "The end of the time period during which you committed to fulfill the order, in ISO-8601 date/time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability, Pending, or Canceled status.";
                                  examples: readonly ["2022-12-07T19:42:04.284Z"];
                                  title: "The LatestDeliveryDate schema";
                                  type: "string";
                              };
                              LatestShipDate: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/LatestShipDate";
                                  description: "The end of the time period during which you committed to ship the order, in ISO-8601 date/time format.";
                                  examples: readonly ["2022-12-07T19:42:04.284Z"];
                                  title: "The LatestShipDate schema";
                                  type: "string";
                              };
                              MarketplaceId: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/MarketplaceId";
                                  description: "The Amazon marketplace identifier of the order.";
                                  examples: readonly ["ATVPDKIKX0DER"];
                                  title: "The MarketplaceId schema";
                                  type: "string";
                              };
                              NumberOfItemsShipped: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/NumberOfItemsShipped";
                                  description: "The number of items shipped.";
                                  examples: readonly [0];
                                  title: "The NumberOfItemsShipped schema";
                                  type: "integer";
                              };
                              NumberOfItemsUnshipped: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/NumberOfItemsUnshipped";
                                  description: "The number of items unshipped.";
                                  examples: readonly [10];
                                  title: "The NumberOfItemsUnshipped schema";
                                  type: "integer";
                              };
                              OrderItems: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems";
                                  description: "Information about order items included in this order. For OrderItemLevel notifications, one payload includes one item, while for OrderLevel notifications, one payload includes all items.";
                                  examples: readonly [readonly [(...)]];
                                  items: {
                                      description: "Information about every order item.";
                                      examples: readonly [(...)];
                                      properties: {
                                          IsBuyerRequestedCancel: ...;
                                          ItemEarliestDeliveryDate: ...;
                                          ItemLatestDeliveryDate: ...;
                                          OrderItemId: ...;
                                          OrderItemStatus: ...;
                                          Quantity: ...;
                                          QuantityShipped: ...;
                                          SellerSKU: ...;
                                          SupplySourceId: ...;
                                      };
                                      required: readonly [(...), (...), (...), (...)];
                                      title: "The OrderItem schema";
                                      type: "object";
                                  };
                                  title: "The OrderItems schema";
                                  type: "array";
                              };
                              OrderPrograms: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderPrograms";
                                  description: "The order programs in which this order participates.";
                                  examples: readonly [readonly [(...)]];
                                  items: {
                                      enum: readonly [(...), (...), (...), (...), (...)];
                                      type: "string";
                                  };
                                  title: "The OrderPrograms schema";
                                  type: "array";
                              };
                              OrderStatus: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderStatus";
                                  description: "The current order status.";
                                  enum: readonly [
                                      "Pending",
                                      "Unshipped",
                                      "PartiallyShipped",
                                      "Shipped",
                                      "Canceled",
                                      "Unfulfillable",
                                      "InvoiceUnconfirmed",
                                      "PendingAvailability",
                                  ];
                                  examples: readonly ["Unshipped"];
                                  title: "The OrderStatus schema";
                                  type: "string";
                              };
                              OrderType: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderType";
                                  description: "The type of the order.";
                                  enum: readonly [
                                      "StandardOrder",
                                      "LongLeadTimeOrder",
                                      "Preorder",
                                      "BackOrder",
                                      "SourcingOnDemandOrder",
                                  ];
                                  examples: readonly ["StandardOrder"];
                                  title: "The OrderType schema";
                                  type: "string";
                              };
                              PurchaseDate: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/PurchaseDate";
                                  description: "The purchase date of the order, in ISO-8601 date/time format. It will be null when there is no related information.";
                                  examples: readonly ["2022-07-13T19:42:04.284Z"];
                                  title: "The PurchaseDate schema";
                                  type: readonly ["string", "null"];
                              };
                              ShippingPrograms: {
                                  $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/ShippingPrograms";
                                  description: "The shipping programs in which this order participates.";
                                  examples: readonly [readonly [(...)]];
                                  items: {
                                      enum: readonly [(...), (...), (...), (...), (...), (...)];
                                      type: "string";
                                  };
                                  title: "The ShippingPrograms schema";
                                  type: "array";
                              };
                          };
                          required: readonly [
                              "MarketplaceId",
                              "OrderStatus",
                              "PurchaseDate",
                              "DestinationPostalCode",
                              "FulfillmentType",
                              "OrderType",
                              "OrderItems",
                          ];
                          title: "The Summary schema";
                          type: "object";
                      };
                  };
                  required: readonly [
                      "NotificationLevel",
                      "SellerId",
                      "AmazonOrderId",
                      "OrderChangeType",
                      "OrderChangeTrigger",
                      "Summary",
                  ];
                  title: "The OrderChangeNotification schema";
                  type: "object";
              };
          };
          required: readonly ["OrderChangeNotification"];
          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"