Selling Partner API SDK for JavaScript

    Variable orderStatusChangeNotificationConst

    orderStatusChangeNotification: {
        $id: "http://example.com/example.json";
        additionalProperties: true;
        default: {};
        description: "The root schema comprises the entire JSON document.";
        examples: readonly [
            {
                EventTime: "2020-07-13T19:42:04.284Z";
                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_STATUS_CHANGE";
                NotificationVersion: "1.0";
                Payload: {
                    OrderStatusChangeNotification: {
                        AmazonOrderId: "333-7777777-7777777";
                        DestinationPostalCode: "48110";
                        FulfillmentChannel: "MFN";
                        MarketplaceId: "ATVPDKIKX0DER";
                        OrderItemId: "OIID34853450";
                        OrderStatus: "Unshipped";
                        PurchaseDate: 1595882000633;
                        Quantity: 45;
                        SellerId: "AXXXXXXXXXXXXX";
                        SellerSKU: "SellerSKUID1";
                        SupplySourceId: "55448834-0d79-5155-75c4-8529543a7c31";
                    };
                };
                PayloadVersion: "1.0";
            },
        ];
        properties: {
            EventTime: {
                $id: "#/properties/EventTime";
                default: "";
                description: "An explanation about the purpose of this instance.";
                examples: readonly ["2020-07-13T19:42:04.284Z"];
                title: "The EventTime schema";
                type: "string";
            };
            NotificationMetadata: {
                $id: "#/properties/NotificationMetadata";
                additionalProperties: true;
                default: {};
                description: "An explanation about the purpose of this instance.";
                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";
                        default: "";
                        description: "An explanation about the purpose of this instance.";
                        examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                        title: "The ApplicationId schema";
                        type: "string";
                    };
                    NotificationId: {
                        $id: "#/properties/NotificationMetadata/properties/NotificationId";
                        default: "";
                        description: "An explanation about the purpose of this instance.";
                        examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                        title: "The NotificationId schema";
                        type: "string";
                    };
                    PublishTime: {
                        $id: "#/properties/NotificationMetadata/properties/PublishTime";
                        default: "";
                        description: "An explanation about the purpose of this instance.";
                        examples: readonly ["2020-07-13T19:42:04.284Z"];
                        title: "The PublishTime schema";
                        type: "string";
                    };
                    SubscriptionId: {
                        $id: "#/properties/NotificationMetadata/properties/SubscriptionId";
                        default: "";
                        description: "An explanation about the purpose of this instance.";
                        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";
                default: "";
                description: "An explanation about the purpose of this instance.";
                examples: readonly ["ORDER_STATUS_CHANGE"];
                title: "The NotificationType schema";
                type: "string";
            };
            NotificationVersion: {
                $id: "#/properties/NotificationVersion";
                default: "";
                description: "An explanation about the purpose of this instance.";
                examples: readonly ["1.0"];
                title: "The NotificationVersion schema";
                type: "string";
            };
            Payload: {
                $id: "#/properties/Payload";
                additionalProperties: true;
                default: {};
                description: "An explanation about the purpose of this instance.";
                examples: readonly [
                    {
                        OrderStatusChangeNotification: {
                            AmazonOrderId: "333-7777777-7777777";
                            DestinationPostalCode: "48110";
                            FulfillmentChannel: "MFN";
                            MarketplaceId: "ATVPDKIKX0DER";
                            OrderItemId: "OIID34853450";
                            OrderStatus: "Unshipped";
                            PurchaseDate: 1595882000633;
                            Quantity: 45;
                            SellerId: "AXXXXXXXXXXXXX";
                            SellerSKU: "SellerSKUID1";
                            SupplySourceId: "55448834-0d79-5155-75c4-8529543a7c31";
                        };
                    },
                ];
                properties: {
                    OrderStatusChangeNotification: {
                        $id: "#/properties/Payload/properties/OrderStatusChangeNotification";
                        additionalProperties: true;
                        default: {};
                        description: "An explanation about the purpose of this instance.";
                        examples: readonly [
                            {
                                AmazonOrderId: "333-7777777-7777777";
                                DestinationPostalCode: "48110";
                                FulfillmentChannel: "MFN";
                                MarketplaceId: "ATVPDKIKX0DER";
                                OrderItemId: "OIID34853450";
                                OrderStatus: "Unshipped";
                                PurchaseDate: 1595882000633;
                                Quantity: 45;
                                SellerId: "AXXXXXXXXXXXXX";
                                SellerSKU: "SellerSKUID1";
                                SupplySourceId: "55448834-0d79-5155-75c4-8529543a7c31";
                            },
                        ];
                        properties: {
                            AmazonOrderId: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/AmazonOrderId";
                                default: "";
                                description: "An Amazon-defined order identifier in 3-7-7 format.";
                                examples: readonly ["333-7777777-7777777"];
                                title: "The AmazonOrderId schema";
                                type: "string";
                            };
                            DestinationPostalCode: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/DestinationPostalCode";
                                default: "";
                                description: "The destination postal code.";
                                examples: readonly ["48110"];
                                title: "The DestinationPostalCode schema";
                                type: readonly ["string", "null"];
                            };
                            FulfillmentChannel: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/FulfillmentChannel";
                                description: "Fulfillment channel of the affected order, MFN or AFN.";
                                examples: readonly ["MFN"];
                                title: "The FulfillmentChannel schema";
                                type: "string";
                            };
                            MarketplaceId: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/MarketplaceId";
                                description: "Amazon marketplace identifier of the affected order.";
                                examples: readonly ["ATVPDKIKX0DER"];
                                title: "The MarketplaceId schema";
                                type: "string";
                            };
                            OrderItemId: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/OrderItemId";
                                default: "";
                                description: "The Amazon-defined order item identifier.";
                                examples: readonly ["OIID34853450"];
                                title: "The OrderItemId schema";
                                type: "string";
                            };
                            OrderStatus: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/OrderStatus";
                                default: "";
                                description: "The current order status. The possible values include UpComing, Pending, Unshipped, PartiallyShipped, PendingAvailability, Canceled, InvoiceUnconfirmed, Shipped, and Unfulfillable.";
                                examples: readonly ["Unshipped"];
                                title: "The OrderStatus schema";
                                type: "string";
                            };
                            PurchaseDate: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/PurchaseDate";
                                default: 0;
                                description: "The purchase date of the order in Epoch time.";
                                examples: readonly [1595882000633];
                                title: "The PurchaseDate schema";
                                type: readonly ["integer", "null"];
                            };
                            Quantity: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/Quantity";
                                default: 0;
                                description: "The number of items in the order.";
                                examples: readonly [45];
                                title: "The Quantity schema";
                                type: "integer";
                            };
                            SellerId: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/SellerId";
                                default: "";
                                description: "The selling partner identifier.";
                                examples: readonly ["AXXXXXXXXXXXXX"];
                                title: "The SellerId schema";
                                type: "string";
                            };
                            SellerSKU: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/SellerSKU";
                                default: "";
                                description: "The seller-specific SKU identifier for an item.";
                                examples: readonly ["SellerSKUID1"];
                                title: "The SellerSKU schema";
                                type: "string";
                            };
                            SupplySourceId: {
                                $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/SupplySourceId";
                                default: "";
                                description: "The unique identifier of the supply source.";
                                examples: readonly ["55448834-0d79-5155-75c4-8529543a7c31"];
                                title: "The SupplySourceId schema";
                                type: readonly ["string", "null"];
                            };
                        };
                        required: readonly [
                            "SellerId",
                            "MarketplaceId",
                            "AmazonOrderId",
                            "PurchaseDate",
                            "OrderStatus",
                            "DestinationPostalCode",
                            "SupplySourceId",
                            "OrderItemId",
                            "SellerSKU",
                            "Quantity",
                            "FulfillmentChannel",
                        ];
                        title: "The OrderStatusChangeNotification schema";
                        type: "object";
                    };
                };
                required: readonly ["OrderStatusChangeNotification"];
                title: "The Payload schema";
                type: "object";
            };
            PayloadVersion: {
                $id: "#/properties/PayloadVersion";
                default: "";
                description: "An explanation about the purpose of this instance.";
                examples: readonly ["1.0"];
                title: "The PayloadVersion schema";
                type: "string";
            };
        };
        required: readonly [
            "NotificationVersion",
            "NotificationType",
            "PayloadVersion",
            "EventTime",
            "Payload",
            "NotificationMetadata",
        ];
        title: "The root schema";
        type: "object";
    } = ...

    Type declaration

    • Readonly$id: "http://example.com/example.json"
    • ReadonlyadditionalProperties: true
    • Readonlydefault: {}
    • Readonlydescription: "The root schema comprises the entire JSON document."
    • Readonlyexamples: readonly [
          {
              EventTime: "2020-07-13T19:42:04.284Z";
              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_STATUS_CHANGE";
              NotificationVersion: "1.0";
              Payload: {
                  OrderStatusChangeNotification: {
                      AmazonOrderId: "333-7777777-7777777";
                      DestinationPostalCode: "48110";
                      FulfillmentChannel: "MFN";
                      MarketplaceId: "ATVPDKIKX0DER";
                      OrderItemId: "OIID34853450";
                      OrderStatus: "Unshipped";
                      PurchaseDate: 1595882000633;
                      Quantity: 45;
                      SellerId: "AXXXXXXXXXXXXX";
                      SellerSKU: "SellerSKUID1";
                      SupplySourceId: "55448834-0d79-5155-75c4-8529543a7c31";
                  };
              };
              PayloadVersion: "1.0";
          },
      ]
    • Readonlyproperties: {
          EventTime: {
              $id: "#/properties/EventTime";
              default: "";
              description: "An explanation about the purpose of this instance.";
              examples: readonly ["2020-07-13T19:42:04.284Z"];
              title: "The EventTime schema";
              type: "string";
          };
          NotificationMetadata: {
              $id: "#/properties/NotificationMetadata";
              additionalProperties: true;
              default: {};
              description: "An explanation about the purpose of this instance.";
              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";
                      default: "";
                      description: "An explanation about the purpose of this instance.";
                      examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                      title: "The ApplicationId schema";
                      type: "string";
                  };
                  NotificationId: {
                      $id: "#/properties/NotificationMetadata/properties/NotificationId";
                      default: "";
                      description: "An explanation about the purpose of this instance.";
                      examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                      title: "The NotificationId schema";
                      type: "string";
                  };
                  PublishTime: {
                      $id: "#/properties/NotificationMetadata/properties/PublishTime";
                      default: "";
                      description: "An explanation about the purpose of this instance.";
                      examples: readonly ["2020-07-13T19:42:04.284Z"];
                      title: "The PublishTime schema";
                      type: "string";
                  };
                  SubscriptionId: {
                      $id: "#/properties/NotificationMetadata/properties/SubscriptionId";
                      default: "";
                      description: "An explanation about the purpose of this instance.";
                      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";
              default: "";
              description: "An explanation about the purpose of this instance.";
              examples: readonly ["ORDER_STATUS_CHANGE"];
              title: "The NotificationType schema";
              type: "string";
          };
          NotificationVersion: {
              $id: "#/properties/NotificationVersion";
              default: "";
              description: "An explanation about the purpose of this instance.";
              examples: readonly ["1.0"];
              title: "The NotificationVersion schema";
              type: "string";
          };
          Payload: {
              $id: "#/properties/Payload";
              additionalProperties: true;
              default: {};
              description: "An explanation about the purpose of this instance.";
              examples: readonly [
                  {
                      OrderStatusChangeNotification: {
                          AmazonOrderId: "333-7777777-7777777";
                          DestinationPostalCode: "48110";
                          FulfillmentChannel: "MFN";
                          MarketplaceId: "ATVPDKIKX0DER";
                          OrderItemId: "OIID34853450";
                          OrderStatus: "Unshipped";
                          PurchaseDate: 1595882000633;
                          Quantity: 45;
                          SellerId: "AXXXXXXXXXXXXX";
                          SellerSKU: "SellerSKUID1";
                          SupplySourceId: "55448834-0d79-5155-75c4-8529543a7c31";
                      };
                  },
              ];
              properties: {
                  OrderStatusChangeNotification: {
                      $id: "#/properties/Payload/properties/OrderStatusChangeNotification";
                      additionalProperties: true;
                      default: {};
                      description: "An explanation about the purpose of this instance.";
                      examples: readonly [
                          {
                              AmazonOrderId: "333-7777777-7777777";
                              DestinationPostalCode: "48110";
                              FulfillmentChannel: "MFN";
                              MarketplaceId: "ATVPDKIKX0DER";
                              OrderItemId: "OIID34853450";
                              OrderStatus: "Unshipped";
                              PurchaseDate: 1595882000633;
                              Quantity: 45;
                              SellerId: "AXXXXXXXXXXXXX";
                              SellerSKU: "SellerSKUID1";
                              SupplySourceId: "55448834-0d79-5155-75c4-8529543a7c31";
                          },
                      ];
                      properties: {
                          AmazonOrderId: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/AmazonOrderId";
                              default: "";
                              description: "An Amazon-defined order identifier in 3-7-7 format.";
                              examples: readonly ["333-7777777-7777777"];
                              title: "The AmazonOrderId schema";
                              type: "string";
                          };
                          DestinationPostalCode: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/DestinationPostalCode";
                              default: "";
                              description: "The destination postal code.";
                              examples: readonly ["48110"];
                              title: "The DestinationPostalCode schema";
                              type: readonly ["string", "null"];
                          };
                          FulfillmentChannel: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/FulfillmentChannel";
                              description: "Fulfillment channel of the affected order, MFN or AFN.";
                              examples: readonly ["MFN"];
                              title: "The FulfillmentChannel schema";
                              type: "string";
                          };
                          MarketplaceId: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/MarketplaceId";
                              description: "Amazon marketplace identifier of the affected order.";
                              examples: readonly ["ATVPDKIKX0DER"];
                              title: "The MarketplaceId schema";
                              type: "string";
                          };
                          OrderItemId: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/OrderItemId";
                              default: "";
                              description: "The Amazon-defined order item identifier.";
                              examples: readonly ["OIID34853450"];
                              title: "The OrderItemId schema";
                              type: "string";
                          };
                          OrderStatus: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/OrderStatus";
                              default: "";
                              description: "The current order status. The possible values include UpComing, Pending, Unshipped, PartiallyShipped, PendingAvailability, Canceled, InvoiceUnconfirmed, Shipped, and Unfulfillable.";
                              examples: readonly ["Unshipped"];
                              title: "The OrderStatus schema";
                              type: "string";
                          };
                          PurchaseDate: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/PurchaseDate";
                              default: 0;
                              description: "The purchase date of the order in Epoch time.";
                              examples: readonly [1595882000633];
                              title: "The PurchaseDate schema";
                              type: readonly ["integer", "null"];
                          };
                          Quantity: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/Quantity";
                              default: 0;
                              description: "The number of items in the order.";
                              examples: readonly [45];
                              title: "The Quantity schema";
                              type: "integer";
                          };
                          SellerId: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/SellerId";
                              default: "";
                              description: "The selling partner identifier.";
                              examples: readonly ["AXXXXXXXXXXXXX"];
                              title: "The SellerId schema";
                              type: "string";
                          };
                          SellerSKU: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/SellerSKU";
                              default: "";
                              description: "The seller-specific SKU identifier for an item.";
                              examples: readonly ["SellerSKUID1"];
                              title: "The SellerSKU schema";
                              type: "string";
                          };
                          SupplySourceId: {
                              $id: "#/properties/Payload/properties/OrderStatusChangeNotification/properties/SupplySourceId";
                              default: "";
                              description: "The unique identifier of the supply source.";
                              examples: readonly ["55448834-0d79-5155-75c4-8529543a7c31"];
                              title: "The SupplySourceId schema";
                              type: readonly ["string", "null"];
                          };
                      };
                      required: readonly [
                          "SellerId",
                          "MarketplaceId",
                          "AmazonOrderId",
                          "PurchaseDate",
                          "OrderStatus",
                          "DestinationPostalCode",
                          "SupplySourceId",
                          "OrderItemId",
                          "SellerSKU",
                          "Quantity",
                          "FulfillmentChannel",
                      ];
                      title: "The OrderStatusChangeNotification schema";
                      type: "object";
                  };
              };
              required: readonly ["OrderStatusChangeNotification"];
              title: "The Payload schema";
              type: "object";
          };
          PayloadVersion: {
              $id: "#/properties/PayloadVersion";
              default: "";
              description: "An explanation about the purpose of this instance.";
              examples: readonly ["1.0"];
              title: "The PayloadVersion schema";
              type: "string";
          };
      }
    • Readonlyrequired: readonly [
          "NotificationVersion",
          "NotificationType",
          "PayloadVersion",
          "EventTime",
          "Payload",
          "NotificationMetadata",
      ]
    • Readonlytitle: "The root schema"
    • Readonlytype: "object"
    MMNEPVFCICPMFPCPTTAAATR