Variable fulfillmentOrderStatusNotificationConst

Type Declaration

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

• ReadonlyadditionalProperties: true

• Readonlydefault: {}

• Readonlydefinitions: {
      Amount: {
          additionalProperties: true;
          default: {};
          properties: {
              unit: {
                  default: "";
                  description: "The unit of measure for the amount. Possible values: EACHES.";
                  examples: readonly ["EACHES"];
                  title: "The unit schema";
                  type: "string";
              };
              value: {
                  default: "";
                  description: "The amount of a product in the associated unit of measurement.";
                  examples: readonly ["2.0"];
                  title: "The value schema";
                  type: "string";
              };
          };
          required: readonly ["unit", "value"];
          type: "object";
      };
      Decimal: {
          default: "";
          description: "A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.";
          examples: readonly ["1.0", "14.99"];
          title: "The Decimal schema";
          type: "string";
      };
      Money: {
          additionalProperties: true;
          default: {};
          description: "An amount of money, including units in the form of currency.";
          examples: readonly [{ amount: "14.99"; currencyCode: "USD" }];
          properties: {
              amount: { $ref: "#/definitions/Decimal" };
              currencyCode: {
                  default: "";
                  description: "Three digit currency code in ISO 4217 format.";
                  examples: readonly ["USD", "EUR", "GBP"];
                  title: "The currencyCode schema";
                  type: "string";
              };
          };
          required: readonly ["currencyCode", "amount"];
          title: "The Money schema";
          type: "object";
      };
      PackageId: {
          default: "";
          description: "Identifies a package in a shipment.";
          examples: readonly ["123", "456", "PKG001"];
          title: "The PackageId schema";
          type: "string";
      };
      ProductIdentifier: {
          additionalProperties: true;
          default: {};
          description: "Identifies a product.";
          examples: readonly [{ amazonSku: "SKU123" }];
          properties: {
              amazonSku: {
                  default: "";
                  description: "The merchant SKU of the item.";
                  examples: readonly ["SKU123"];
                  title: "The amazonSku schema";
                  type: "string";
              };
          };
          required: readonly ["amazonSku"];
          title: "The ProductIdentifier schema";
          type: "object";
      };
      Tracking: {
          additionalProperties: true;
          default: {};
          description: "Tracking information for a package.";
          properties: {
              amazon: {
                  additionalProperties: true;
                  default: {};
                  description: "Amazon tracking information for a package.";
                  properties: {
                      trackingNumber: {
                          $ref: "#/definitions/TrackingNumber";
                          description: "The Amazon tracking number that can be used to obtain tracking and delivery information.";
                          title: "The trackingNumber schema";
                      };
                  };
                  title: "The amazon schema";
                  type: "object";
              };
              carrier: {
                  additionalProperties: true;
                  default: {};
                  description: "Carrier tracking information for a package.";
                  properties: {
                      carrierCode: {
                          default: "";
                          description: "Identifies the carrier who delivers the shipment to the recipient.";
                          examples: readonly ["FEDEX"];
                          title: "The carrierCode schema";
                          type: "string";
                      };
                      trackingNumber: {
                          $ref: "#/definitions/TrackingNumber";
                          description: "The tracking number, if provided, can be used to obtain tracking and delivery information.";
                          title: "The trackingNumber schema";
                      };
                  };
                  required: readonly ["carrierCode"];
                  title: "The carrier schema";
                  type: "object";
              };
          };
          title: "The Tracking schema";
          type: "object";
      };
      TrackingNumber: {
          default: "";
          description: "The tracking number, if provided, can be used to obtain tracking and delivery information.";
          examples: readonly ["123456789", "234567890"];
          title: "The TrackingNumber schema";
          type: "string";
      };
  }

• Readonlydescription: "The root schema comprises the entire JSON document."

• Readonlyexamples: readonly [
      {
          EventTime: "2026-07-04T00:02:48.501Z";
          NotificationMetadata: {
              ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
              NotificationId: "2012e8e5-b365-4cb1-9fd8-be9dfc6d5eaf";
              PublishTime: "2026-07-04T00:02:50.501Z";
              SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
          };
          NotificationType: "FULFILLMENT_ORDER_STATUS";
          NotificationVersion: "1.0";
          Payload: {
              eventType: "ORDER_STATUS_CHANGED";
              fulfillmentServiceId: "FS01-o8vlfw8b1tiu1";
              merchantId: "A3TH9S8BH6GOGM";
              order: {
                  lineItems: readonly [
                      {
                          amount: { unit: "EACHES"; value: "2.0" };
                          cancelledAmount: { unit: "EACHES"; value: "0" };
                          lineItemId: "LI789012";
                          product: {
                              perUnitDeclaredValue: { amount: "14.99"; currencyCode: "USD" };
                              productIdentifier: { amazonSku: "SKU123" };
                          };
                          unfulfillableAmount: { unit: "EACHES"; value: "0" };
                      },
                  ];
                  orderId: "ORD123XYZ";
                  shipments: readonly [
                      {
                          amazonFacility: { facilityId: "FC456" };
                          amazonShipmentId: "SHIP901234";
                          items: readonly [
                              {
                                  amount: { unit: "EACHES"; value: "1.0" };
                                  lineItemId: "LI789012";
                                  packageId: "123";
                                  productIdentifier: { amazonSku: "SKU123" };
                                  unitIdentifiers: { IMEI: readonly [(...)] };
                              },
                          ];
                          packages: readonly [
                              {
                                  deliveryTime: "2026-07-03T18:45:00.000Z";
                                  packageId: "123";
                                  shipmentItemIds: readonly ["SI001"];
                                  status: "DELIVERED";
                                  tracking: {
                                      amazon: { trackingNumber: ... };
                                      carrier: { carrierCode: ...; trackingNumber: ... };
                                  };
                              },
                          ];
                          status: "SHIPPED";
                      },
                  ];
                  status: "COMPLETE";
              };
          };
          PayloadVersion: "2026-07-04";
      },
  ]

• Readonlyproperties: {
      EventTime: {
          $id: "#/properties/EventTime";
          default: "";
          description: "Timestamp of the event, formatted as ISO 8601 date-time.";
          examples: readonly ["2026-07-04T00:02:48.501Z"];
          title: "The EventTime schema";
          type: "string";
      };
      NotificationMetadata: {
          $id: "#/properties/NotificationMetadata";
          additionalProperties: true;
          default: {};
          description: "Metadata about the notification.";
          examples: readonly [
              {
                  ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                  NotificationId: "2012e8e5-b365-4cb1-9fd8-be9dfc6d5eaf";
                  PublishTime: "2026-07-04T00:02:50.501Z";
                  SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
              },
          ];
          properties: {
              ApplicationId: {
                  $id: "#/properties/NotificationMetadata/properties/ApplicationId";
                  default: "";
                  description: "The application ID that subscribed to this notification.";
                  examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                  title: "The ApplicationId schema";
                  type: "string";
              };
              NotificationId: {
                  $id: "#/properties/NotificationMetadata/properties/NotificationId";
                  default: "";
                  description: "The unique identifier for this notification.";
                  examples: readonly ["2012e8e5-b365-4cb1-9fd8-be9dfc6d5eaf"];
                  title: "The NotificationId schema";
                  type: "string";
              };
              PublishTime: {
                  $id: "#/properties/NotificationMetadata/properties/PublishTime";
                  default: "";
                  description: "Timestamp of when the notification was published, formatted as ISO 8601 date-time.";
                  examples: readonly ["2026-07-04T00:02:50.501Z"];
                  title: "The PublishTime schema";
                  type: "string";
              };
              SubscriptionId: {
                  $id: "#/properties/NotificationMetadata/properties/SubscriptionId";
                  default: "";
                  description: "The subscription ID for 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";
          default: "";
          description: "The type of notification being sent.";
          examples: readonly ["FULFILLMENT_ORDER_STATUS"];
          title: "The NotificationType schema";
          type: "string";
      };
      NotificationVersion: {
          $id: "#/properties/NotificationVersion";
          default: "";
          description: "The version of the notification.";
          examples: readonly ["1.0"];
          title: "The NotificationVersion schema";
          type: "string";
      };
      Payload: {
          $id: "#/properties/Payload";
          additionalProperties: true;
          default: {};
          description: "Contains the fulfillment order status notification data.";
          properties: {
              eventType: {
                  $id: "#/properties/Payload/properties/eventType";
                  default: "";
                  description: "The type of event that triggered this notification.";
                  examples: readonly [
                      "ORDER_STATUS_CHANGED",
                      "SHIPMENT_STATUS_CHANGED",
                      "SHIPMENT_PACKAGE_STATUS_CHANGED",
                  ];
                  title: "The eventType schema";
                  type: "string";
              };
              fulfillmentServiceId: {
                  $id: "#/properties/Payload/properties/fulfillmentServiceId";
                  default: "";
                  description: "The identifier of the fulfillment service used for this operation.";
                  examples: readonly ["FS01-o8vlfw8b1tiu1"];
                  title: "The fulfillmentServiceId schema";
                  type: "string";
              };
              merchantId: {
                  $id: "#/properties/Payload/properties/merchantId";
                  default: "";
                  description: "The merchant identifier for the fulfillment order.";
                  examples: readonly ["A3TH9S8BH6GOGM"];
                  title: "The merchantId schema";
                  type: "string";
              };
              order: {
                  $id: "#/properties/Payload/properties/order";
                  additionalProperties: true;
                  default: {};
                  description: "Contains detailed information about the fulfillment order.";
                  properties: {
                      lineItems: {
                          $id: "#/properties/Payload/properties/order/properties/lineItems";
                          default: readonly [];
                          description: "A list of items to include in the fulfillment order, including quantity.";
                          items: {
                              $id: "#/properties/Payload/properties/order/properties/lineItems/items";
                              additionalProperties: true;
                              default: {};
                              description: "A line item in the fulfillment order.";
                              properties: {
                                  amount: {
                                      $id: "#/properties/Payload/properties/order/properties/lineItems/items/properties/amount";
                                      $ref: "#/definitions/Amount";
                                      description: "A quantity based on the specified unit of measurement.";
                                      title: "The amount schema";
                                  };
                                  cancelledAmount: {
                                      $id: "#/properties/Payload/properties/order/properties/lineItems/items/properties/cancelledAmount";
                                      $ref: "#/definitions/Amount";
                                      description: "The cancelled quantity based on the specified unit of measurement.";
                                      title: "The cancelledAmount schema";
                                  };
                                  lineItemId: {
                                      $id: "#/properties/Payload/properties/order/properties/lineItems/items/properties/lineItemId";
                                      default: "";
                                      description: "The line item identifier for the fulfillment order.";
                                      examples: readonly [(...)];
                                      title: "The lineItemId schema";
                                      type: "string";
                                  };
                                  product: {
                                      $id: "#/properties/Payload/properties/order/properties/lineItems/items/properties/product";
                                      additionalProperties: true;
                                      default: {};
                                      description: "Product information for the line item.";
                                      properties: { perUnitDeclaredValue: ...; productIdentifier: ... };
                                      required: readonly [(...)];
                                      title: "The product schema";
                                      type: "object";
                                  };
                                  unfulfillableAmount: {
                                      $id: "#/properties/Payload/properties/order/properties/lineItems/items/properties/unfulfillableAmount";
                                      $ref: "#/definitions/Amount";
                                      description: "The unfulfillable quantity based on the specified unit of measurement.";
                                      title: "The unfulfillableAmount schema";
                                  };
                              };
                              required: readonly ["lineItemId", "product", "amount"];
                              title: "The lineItem schema";
                              type: "object";
                          };
                          title: "The lineItems schema";
                          type: "array";
                      };
                      orderId: {
                          $id: "#/properties/Payload/properties/order/properties/orderId";
                          default: "";
                          description: "The fulfillment order identifier submitted with the `createOrder` operation.";
                          examples: readonly ["ORD123XYZ"];
                          title: "The orderId schema";
                          type: "string";
                      };
                      shipments: {
                          $id: "#/properties/Payload/properties/order/properties/shipments";
                          default: readonly [];
                          description: "An array of fulfillment shipment information.";
                          items: {
                              $id: "#/properties/Payload/properties/order/properties/shipments/items";
                              additionalProperties: true;
                              default: {};
                              description: "Delivery and item information for a shipment in a fulfillment order.";
                              properties: {
                                  amazonFacility: {
                                      $id: "#/properties/Payload/properties/order/properties/shipments/items/properties/amazonFacility";
                                      additionalProperties: true;
                                      default: {};
                                      description: "The Amazon facility from which the shipment is sent.";
                                      properties: { facilityId: ... };
                                      required: readonly [(...)];
                                      title: "The amazonFacility schema";
                                      type: "object";
                                  };
                                  amazonShipmentId: {
                                      $id: "#/properties/Payload/properties/order/properties/shipments/items/properties/amazonShipmentId";
                                      default: "";
                                      description: "A shipment identifier assigned by Amazon.";
                                      examples: readonly [(...)];
                                      title: "The amazonShipmentId schema";
                                      type: "string";
                                  };
                                  items: {
                                      $id: "#/properties/Payload/properties/order/properties/shipments/items/properties/items";
                                      default: readonly [];
                                      description: "An array of fulfillment shipment item information.";
                                      items: {
                                          $id: ...;
                                          additionalProperties: ...;
                                          default: ...;
                                          description: ...;
                                          properties: ...;
                                          required: ...;
                                          title: ...;
                                          type: ...;
                                      };
                                      title: "The items schema";
                                      type: "array";
                                  };
                                  packages: {
                                      $id: "#/properties/Payload/properties/order/properties/shipments/items/properties/packages";
                                      default: readonly [];
                                      description: "An array of fulfillment shipment package information.";
                                      items: {
                                          $id: ...;
                                          additionalProperties: ...;
                                          default: ...;
                                          description: ...;
                                          properties: ...;
                                          required: ...;
                                          title: ...;
                                          type: ...;
                                      };
                                      title: "The packages schema";
                                      type: "array";
                                  };
                                  status: {
                                      $id: "#/properties/Payload/properties/order/properties/shipments/items/properties/status";
                                      default: "";
                                      description: "The current status of the shipment. Possible values are PROCESSING, SHIPPED, CANCELLED.";
                                      examples: readonly [(...), (...), (...)];
                                      title: "The status schema";
                                      type: "string";
                                  };
                              };
                              required: readonly ["amazonShipmentId", "status", "items"];
                              title: "The shipment schema";
                              type: "object";
                          };
                          title: "The shipments schema";
                          type: "array";
                      };
                      status: {
                          $id: "#/properties/Payload/properties/order/properties/status";
                          default: "";
                          description: "The current status of the fulfillment order. Possible values are PROCESSING, COMPLETE, COMPLETE_PARTIAL, CANCELLED, UNFULFILLABLE, INVALID.";
                          examples: readonly [
                              "PROCESSING",
                              "COMPLETE",
                              "COMPLETE_PARTIAL",
                              "CANCELLED",
                              "UNFULFILLABLE",
                              "INVALID",
                          ];
                          title: "The status schema";
                          type: "string";
                      };
                  };
                  required: readonly ["orderId", "status"];
                  title: "The order schema";
                  type: "object";
              };
          };
          required: readonly ["merchantId", "eventType", "order"];
          title: "The Payload schema";
          type: "object";
      };
      PayloadVersion: {
          $id: "#/properties/PayloadVersion";
          default: "";
          description: "The version of the payload format.";
          examples: readonly ["2026-07-04"];
          title: "The PayloadVersion schema";
          type: "string";
      };
  }

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

• Readonlytitle: "The root schema"

• Readonlytype: "object"