@sp-api-sdk/schemas
Version:
Selling Parner API additional schema types
564 lines (563 loc) • 42.8 kB
TypeScript
import { type FromSchema } from 'json-schema-to-ts';
export declare const orderChangeNotification: {
readonly $id: "http://example.com/example.json";
readonly type: "object";
readonly title: "The root schema";
readonly description: "The notification response schema that comprises the entire JSON document for ORDER_CHANGE notification.";
readonly examples: readonly [{
readonly NotificationVersion: "1.0";
readonly NotificationType: "ORDER_CHANGE";
readonly PayloadVersion: "1.0";
readonly EventTime: "2020-01-11T00:09:53.109Z";
readonly Payload: {
readonly OrderChangeNotification: {
readonly NotificationLevel: "OrderLevel";
readonly SellerId: "A3TH9S8BH6GOGM";
readonly AmazonOrderId: "903-8868176-2219830";
readonly OrderChangeType: "BuyerRequestedChange";
readonly OrderChangeTrigger: {
readonly TimeOfOrderChange: "2022-11-29T19:42:04.284Z";
readonly ChangeReason: "Buyer Requested Cancel";
};
readonly Summary: {
readonly MarketplaceId: "ATVPDKIKX0DER";
readonly OrderStatus: "Unshipped";
readonly PurchaseDate: "2022-07-13T19:42:04.284Z";
readonly DestinationPostalCode: "48110";
readonly FulfillmentType: "MFN";
readonly OrderType: "StandardOrder";
readonly NumberOfItemsShipped: 0;
readonly NumberOfItemsUnshipped: 10;
readonly EarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly LatestDeliveryDate: "2022-12-07T19:42:04.284Z";
readonly EarliestShipDate: "2022-11-07T19:42:04.284Z";
readonly LatestShipDate: "2022-12-07T19:42:04.284Z";
readonly CancelNotifyDate: "2022-12-07T19:42:04.284Z";
readonly OrderPrograms: readonly ["Business"];
readonly ShippingPrograms: readonly ["EasyShip"];
readonly EasyShipShipmentStatus: "Delivered";
readonly ElectronicInvoiceStatus: "NotFound";
readonly OrderItems: readonly [{
readonly OrderItemId: "OIID34853450";
readonly SellerSKU: "SellerSKUID1";
readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3";
readonly OrderItemStatus: "Unshipped";
readonly Quantity: 10;
readonly QuantityShipped: 0;
readonly IsBuyerRequestedCancel: true;
readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z";
}];
};
};
};
readonly NotificationMetadata: {
readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
readonly PublishTime: "2020-07-13T19:42:04.284Z";
readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
};
}];
readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"];
readonly properties: {
readonly NotificationVersion: {
readonly $id: "#/properties/NotificationVersion";
readonly type: "string";
readonly title: "The NotificationVersion schema";
readonly description: "The notification version.";
readonly examples: readonly ["1.0"];
};
readonly NotificationType: {
readonly $id: "#/properties/NotificationType";
readonly type: "string";
readonly title: "The NotificationType schema";
readonly description: "The type of this notification, used to differentiate different notifications. Combined with payload version, this controls the structure of the payload object.";
readonly examples: readonly ["ORDER_CHANGE"];
};
readonly PayloadVersion: {
readonly $id: "#/properties/PayloadVersion";
readonly type: "string";
readonly title: "The PayloadVersion schema";
readonly description: "The payload version of the notification.";
readonly examples: readonly ["1.0"];
};
readonly EventTime: {
readonly $id: "#/properties/EventTime";
readonly type: "string";
readonly title: "The EventTime schema";
readonly description: "The time when this notification was published, in ISO-8601 date/time format.";
readonly examples: readonly ["2020-01-11T00:09:53.109Z"];
};
readonly Payload: {
readonly $id: "#/properties/Payload";
readonly type: "object";
readonly title: "The Payload schema";
readonly description: "The payload for the ORDER_CHANGE notification.";
readonly examples: readonly [{
readonly OrderChangeNotification: {
readonly NotificationLevel: "OrderLevel";
readonly SellerId: "A3TH9S8BH6GOGM";
readonly AmazonOrderId: "903-8868176-2219830";
readonly OrderChangeType: "BuyerRequestedChange";
readonly OrderChangeTrigger: {
readonly TimeOfOrderChange: "2022-11-29T19:42:04.284Z";
readonly ChangeReason: "Buyer Requested Cancel";
};
readonly Summary: {
readonly MarketplaceId: "ATVPDKIKX0DER";
readonly OrderStatus: "Unshipped";
readonly PurchaseDate: "2022-07-13T19:42:04.284Z";
readonly DestinationPostalCode: "48110";
readonly FulfillmentType: "MFN";
readonly OrderType: "StandardOrder";
readonly NumberOfItemsShipped: 0;
readonly NumberOfItemsUnshipped: 10;
readonly EarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly LatestDeliveryDate: "2022-12-07T19:42:04.284Z";
readonly EarliestShipDate: "2022-11-07T19:42:04.284Z";
readonly LatestShipDate: "2022-12-07T19:42:04.284Z";
readonly CancelNotifyDate: "2022-12-07T19:42:04.284Z";
readonly OrderPrograms: readonly ["Business"];
readonly ShippingPrograms: readonly ["EasyShip"];
readonly EasyShipShipmentStatus: "Delivered";
readonly ElectronicInvoiceStatus: "NotFound";
readonly OrderItems: readonly [{
readonly OrderItemId: "OIID34853450";
readonly SellerSKU: "SellerSKUID1";
readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3";
readonly OrderItemStatus: "Unshipped";
readonly Quantity: 10;
readonly QuantityShipped: 0;
readonly IsBuyerRequestedCancel: true;
readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z";
}];
};
};
}];
readonly required: readonly ["OrderChangeNotification"];
readonly properties: {
readonly OrderChangeNotification: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification";
readonly type: "object";
readonly title: "The OrderChangeNotification schema";
readonly description: "An explanation about the ORDER_CHANGE notification.";
readonly examples: readonly [{
readonly NotificationLevel: "OrderLevel";
readonly SellerId: "A3TH9S8BH6GOGM";
readonly AmazonOrderId: "903-8868176-2219830";
readonly OrderChangeType: "BuyerRequestedChange";
readonly OrderChangeTrigger: {
readonly TimeOfOrderChange: "2022-11-29T19:42:04.284Z";
readonly ChangeReason: "Buyer Requested Cancel";
};
readonly Summary: {
readonly MarketplaceId: "ATVPDKIKX0DER";
readonly OrderStatus: "Unshipped";
readonly PurchaseDate: "2022-07-13T19:42:04.284Z";
readonly DestinationPostalCode: "48110";
readonly FulfillmentType: "MFN";
readonly OrderType: "StandardOrder";
readonly NumberOfItemsShipped: 0;
readonly NumberOfItemsUnshipped: 10;
readonly EarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly LatestDeliveryDate: "2022-12-07T19:42:04.284Z";
readonly EarliestShipDate: "2022-11-07T19:42:04.284Z";
readonly LatestShipDate: "2022-12-07T19:42:04.284Z";
readonly CancelNotifyDate: "2022-12-07T19:42:04.284Z";
readonly OrderPrograms: readonly ["Business"];
readonly ShippingPrograms: readonly ["EasyShip"];
readonly EasyShipShipmentStatus: "Delivered";
readonly ElectronicInvoiceStatus: "NotFound";
readonly OrderItems: readonly [{
readonly OrderItemId: "OIID34853450";
readonly SellerSKU: "SellerSKUID1";
readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3";
readonly OrderItemStatus: "Unshipped";
readonly Quantity: 10;
readonly QuantityShipped: 0;
readonly IsBuyerRequestedCancel: true;
readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z";
}];
};
}];
readonly required: readonly ["NotificationLevel", "SellerId", "AmazonOrderId", "OrderChangeType", "OrderChangeTrigger", "Summary"];
readonly properties: {
readonly NotificationLevel: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/NotificationLevel";
readonly type: "string";
readonly enum: readonly ["OrderItemLevel", "OrderLevel"];
readonly title: "The NotificationLevel schema";
readonly description: "The notification level of current notification.";
readonly examples: readonly ["OrderLevel"];
};
readonly SellerId: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/SellerId";
readonly type: "string";
readonly title: "The SellerId schema";
readonly description: "The selling partner identifier.";
readonly examples: readonly ["AXXXXXXXXXXXXX"];
};
readonly AmazonOrderId: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/AmazonOrderId";
readonly type: "string";
readonly title: "The AmazonOrderId schema";
readonly description: "The Amazon order identifier, in 3-7-7 format.";
readonly examples: readonly ["903-8868176-2219830"];
};
readonly OrderChangeType: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeType";
readonly type: "string";
readonly enum: readonly ["BuyerRequestedChange", "OrderStatusChange"];
readonly title: "The OrderChangeType schema";
readonly description: "The type of order change that caused the notification to be sent. Possible values are BuyerRequestedChange and OrderStatusChange.";
readonly examples: readonly ["BuyerRequestedChange"];
};
readonly OrderChangeTrigger: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeTrigger";
readonly type: "object";
readonly title: "The OrderChangeTrigger schema";
readonly description: "Details about what caused this ORDER_CHANGE notification to be sent.";
readonly examples: readonly [{
readonly TimeOfOrderChange: "2022-11-29T19:42:04.284Z";
readonly ChangeReason: "Buyer Requested Cancel";
}];
readonly required: readonly ["TimeOfOrderChange", "ChangeReason"];
readonly properties: {
readonly TimeOfOrderChange: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeTrigger/properties/TimeOfOrderChange";
readonly type: readonly ["string", "null"];
readonly title: "The TimeOfOrderChange schema";
readonly 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.";
readonly examples: readonly ["2022-11-29T19:42:04.284Z"];
};
readonly ChangeReason: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeTrigger/properties/ChangeReason";
readonly type: "string";
readonly title: "The ChangeReason schema";
readonly description: "The reason this ORDER_CHANGE notification was sent.";
readonly examples: readonly ["Buyer Requested Cancel"];
};
};
};
readonly Summary: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary";
readonly type: "object";
readonly title: "The Summary schema";
readonly description: "Information about the order and order items that had the change.";
readonly examples: readonly [{
readonly MarketplaceId: "ATVPDKIKX0DER";
readonly OrderStatus: "Unshipped";
readonly PurchaseDate: "2022-07-13T19:42:04.284Z";
readonly DestinationPostalCode: "48110";
readonly FulfillmentType: "MFN";
readonly OrderType: "StandardOrder";
readonly NumberOfItemsShipped: 0;
readonly NumberOfItemsUnshipped: 10;
readonly EarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly LatestDeliveryDate: "2022-12-07T19:42:04.284Z";
readonly EarliestShipDate: "2022-11-07T19:42:04.284Z";
readonly LatestShipDate: "2022-12-07T19:42:04.284Z";
readonly CancelNotifyDate: "2022-12-07T19:42:04.284Z";
readonly OrderPrograms: readonly ["Business"];
readonly ShippingPrograms: readonly ["EasyShip"];
readonly EasyShipShipmentStatus: "Delivered";
readonly ElectronicInvoiceStatus: "NotFound";
readonly OrderItems: readonly [{
readonly OrderItemId: "OIID34853450";
readonly SellerSKU: "SellerSKUID1";
readonly OrderItemStatus: "Unshipped";
readonly Quantity: 10;
readonly QuantityShipped: 0;
readonly IsBuyerRequestedCancel: true;
readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z";
}];
}];
readonly required: readonly ["MarketplaceId", "OrderStatus", "PurchaseDate", "DestinationPostalCode", "FulfillmentType", "OrderType", "OrderItems"];
readonly properties: {
readonly MarketplaceId: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/MarketplaceId";
readonly type: "string";
readonly title: "The MarketplaceId schema";
readonly description: "The Amazon marketplace identifier of the order.";
readonly examples: readonly ["ATVPDKIKX0DER"];
};
readonly OrderStatus: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderStatus";
readonly type: "string";
readonly enum: readonly ["Pending", "Unshipped", "PartiallyShipped", "Shipped", "Canceled", "Unfulfillable", "InvoiceUnconfirmed", "PendingAvailability"];
readonly title: "The OrderStatus schema";
readonly description: "The current order status.";
readonly examples: readonly ["Unshipped"];
};
readonly PurchaseDate: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/PurchaseDate";
readonly type: readonly ["string", "null"];
readonly title: "The PurchaseDate schema";
readonly description: "The purchase date of the order, in ISO-8601 date/time format. It will be null when there is no related information.";
readonly examples: readonly ["2022-07-13T19:42:04.284Z"];
};
readonly DestinationPostalCode: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/DestinationPostalCode";
readonly type: readonly ["string", "null"];
readonly title: "The DestinationPostalCode schema";
readonly description: "The destination postal code. It will be null when there is no related information.";
readonly examples: readonly ["48110"];
};
readonly FulfillmentType: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/FulfillmentType";
readonly type: "string";
readonly enum: readonly ["AFN", "MFN"];
readonly title: "The FulfillmentType schema";
readonly description: "Fulfillment type of the affected order, MFN or AFN.";
readonly examples: readonly ["MFN"];
};
readonly OrderType: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderType";
readonly type: "string";
readonly enum: readonly ["StandardOrder", "LongLeadTimeOrder", "Preorder", "BackOrder", "SourcingOnDemandOrder"];
readonly title: "The OrderType schema";
readonly description: "The type of the order.";
readonly examples: readonly ["StandardOrder"];
};
readonly NumberOfItemsShipped: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/NumberOfItemsShipped";
readonly type: "integer";
readonly title: "The NumberOfItemsShipped schema";
readonly description: "The number of items shipped.";
readonly examples: readonly [0];
};
readonly NumberOfItemsUnshipped: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/NumberOfItemsUnshipped";
readonly type: "integer";
readonly title: "The NumberOfItemsUnshipped schema";
readonly description: "The number of items unshipped.";
readonly examples: readonly [10];
};
readonly EarliestDeliveryDate: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/EarliestDeliveryDate";
readonly type: "string";
readonly title: "The EarliestDeliveryDate schema";
readonly 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.";
readonly examples: readonly ["2022-11-07T19:42:04.284Z"];
};
readonly LatestDeliveryDate: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/LatestDeliveryDate";
readonly type: "string";
readonly title: "The LatestDeliveryDate schema";
readonly 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.";
readonly examples: readonly ["2022-12-07T19:42:04.284Z"];
};
readonly EarliestShipDate: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/EarliestShipDate";
readonly type: "string";
readonly title: "The EarliestShipDate schema";
readonly description: "The start of the time period during which you committed to ship the order, in ISO-8601 date/time format.";
readonly examples: readonly ["2022-11-07T19:42:04.284Z"];
};
readonly LatestShipDate: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/LatestShipDate";
readonly type: "string";
readonly title: "The LatestShipDate schema";
readonly description: "The end of the time period during which you committed to ship the order, in ISO-8601 date/time format.";
readonly examples: readonly ["2022-12-07T19:42:04.284Z"];
};
readonly CancelNotifyDate: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/CancelNotifyDate";
readonly type: "string";
readonly title: "The CancelNotifyDate schema";
readonly description: "The end of the time period during which you must notify the seller of possible cancellation, in ISO-8601 date/time format.";
readonly examples: readonly ["2022-12-07T19:42:04.284Z"];
};
readonly OrderPrograms: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderPrograms";
readonly type: "array";
readonly title: "The OrderPrograms schema";
readonly description: "The order programs in which this order participates.";
readonly items: {
readonly type: "string";
readonly enum: readonly ["Business", "Prime", "Premium", "IBA", "Replacement"];
};
readonly examples: readonly [readonly ["Business"]];
};
readonly ShippingPrograms: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/ShippingPrograms";
readonly type: "array";
readonly title: "The ShippingPrograms schema";
readonly description: "The shipping programs in which this order participates.";
readonly items: {
readonly type: "string";
readonly enum: readonly ["ShipDateSet", "GlobalExpress", "ISPU", "AccessPoint", "TFM", "EasyShip"];
};
readonly examples: readonly [readonly ["EasyShip"]];
};
readonly EasyShipShipmentStatus: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/EasyShipShipmentStatus";
readonly type: "string";
readonly enum: readonly ["PendingSchedule", "PendingPickUp", "PendingDropOff", "LabelCanceled", "PickedUp", "DroppedOff", "AtOriginFC", "AtDestinationFC", "Delivered", "RejectedByBuyer", "Undeliverable", "ReturningToSeller", "ReturnedToSeller", "Lost", "OutForDelivery", "Damaged"];
readonly title: "The EasyShipShipmentStatus schema";
readonly description: "The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.";
readonly examples: readonly ["Delivered"];
};
readonly ElectronicInvoiceStatus: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/ElectronicInvoiceStatus";
readonly type: "string";
readonly enum: readonly ["NotRequired", "NotFound", "Processing", "Errored", "Accepted"];
readonly title: "The ElectronicInvoiceStatus schema";
readonly description: "The status of the electronic invoice.";
readonly examples: readonly ["NotFound"];
};
readonly OrderItems: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems";
readonly type: "array";
readonly title: "The OrderItems schema";
readonly 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.";
readonly examples: readonly [readonly [{
readonly OrderItemId: "OIID34853450";
readonly SellerSKU: "SellerSKUID1";
readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3";
readonly OrderItemStatus: "Unshipped";
readonly Quantity: 10;
readonly QuantityShipped: 0;
readonly IsBuyerRequestedCancel: true;
readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z";
}]];
readonly items: {
readonly type: "object";
readonly title: "The OrderItem schema";
readonly description: "Information about every order item.";
readonly examples: readonly [{
readonly OrderItemId: "OIID34853450";
readonly SellerSKU: "SellerSKUID1";
readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3";
readonly OrderItemStatus: "Unshipped";
readonly Quantity: 10;
readonly QuantityShipped: 0;
readonly IsBuyerRequestedCancel: true;
readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z";
readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z";
}];
readonly required: readonly ["OrderItemId", "SellerSKU", "SupplySourceId", "Quantity"];
readonly properties: {
readonly OrderItemId: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/OrderItemId";
readonly type: "string";
readonly title: "The OrderItemId schema";
readonly description: "The Amazon-defined order item identifier.";
readonly examples: readonly ["OIID34853450"];
};
readonly SellerSKU: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/SellerSKU";
readonly type: "string";
readonly title: "The SellerSKU schema";
readonly description: "The seller-specific SKU for an item.";
readonly examples: readonly ["SellerSKUID1"];
};
readonly SupplySourceId: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/SupplySourceId";
readonly type: readonly ["string", "null"];
readonly title: "The SupplySourceId schema";
readonly description: "The unique identifier of the supply source. Will be null when there is no related information.";
readonly examples: readonly ["d7679e14-031b-4ab3-a81b-ec4fc7a460b3"];
};
readonly OrderItemStatus: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/OrderItemStatus";
readonly type: "string";
readonly enum: readonly ["Unshipped", "Shipped"];
readonly title: "The OrderItemStatus schema";
readonly description: "The current status of the order item. This field Will have a non-null value when items' statuses are different.";
readonly examples: readonly ["Unshipped"];
};
readonly Quantity: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/Quantity";
readonly type: "integer";
readonly title: "The Quantity schema";
readonly description: "The number of items in the order.";
readonly examples: readonly [10];
};
readonly QuantityShipped: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/QuantityShipped";
readonly type: "integer";
readonly title: "The QuantityShipped schema";
readonly description: "The number of items shipped.";
readonly examples: readonly [0];
};
readonly IsBuyerRequestedCancel: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/IsBuyerRequestedCancel";
readonly type: "boolean";
readonly title: "The IsBuyerRequestedCancel schema";
readonly description: "True when the buyer has requested cancelation.";
readonly examples: readonly [true];
};
readonly ItemEarliestDeliveryDate: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/ItemEarliestDeliveryDate";
readonly type: "string";
readonly title: "The ItemEarliestDeliveryDate schema";
readonly description: "The start of the time period during which you have committed to fulfill the order.";
readonly examples: readonly ["2022-11-07T19:42:04.284Z"];
};
readonly ItemLatestDeliveryDate: {
readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/ItemLatestDeliveryDate";
readonly type: "string";
readonly title: "The ItemLatestDeliveryDate schema";
readonly description: "The end of the time period during which you have committed to fulfill the order.";
readonly examples: readonly ["2022-12-07T19:42:04.284Z"];
};
};
};
};
};
};
};
};
};
};
readonly NotificationMetadata: {
readonly $id: "#/properties/NotificationMetadata";
readonly type: "object";
readonly title: "The NotificationMetadata schema";
readonly description: "The notification metadata.";
readonly examples: readonly [{
readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
readonly PublishTime: "2020-07-13T19:42:04.284Z";
readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
}];
readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"];
readonly properties: {
readonly ApplicationId: {
readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId";
readonly type: "string";
readonly title: "The ApplicationId schema";
readonly description: "The identifier for the application that uses the notifications.";
readonly examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
};
readonly SubscriptionId: {
readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId";
readonly type: "string";
readonly title: "The SubscriptionId schema";
readonly description: "A unique identifier for the subscription which resulted in this notification.";
readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
};
readonly PublishTime: {
readonly $id: "#/properties/NotificationMetadata/properties/PublishTime";
readonly type: "string";
readonly title: "The PublishTime schema";
readonly description: "The date and time (in UTC) that the notification was sent, in ISO-8601 date/time format.";
readonly examples: readonly ["2020-07-13T19:42:04.284Z"];
};
readonly NotificationId: {
readonly $id: "#/properties/NotificationMetadata/properties/NotificationId";
readonly type: "string";
readonly title: "The NotificationId schema";
readonly description: "A unique identifier for this notification instance.";
readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
};
};
};
};
};
export type OrderChangeNotification = FromSchema<typeof orderChangeNotification>;