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