@sp-api-sdk/schemas
Version:
Selling Parner API additional schema types
478 lines (477 loc) • 32.7 kB
TypeScript
import { type FromSchema } from 'json-schema-to-ts';
export declare const fulfillmentOrderStatusNotification: {
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: "FULFILLMENT_ORDER_STATUS";
readonly PayloadVersion: "1.0";
readonly EventTime: "2020-07-13T19:42:04.284Z";
readonly Payload: {
readonly FulfillmentOrderStatusNotification: {
readonly SellerId: "A3TH9S8BH6GOGM";
readonly EventType: "TYPE3945";
readonly StatusUpdatedDateTime: "2020-07-13T19:42:04.284Z";
readonly SellerFulfillmentOrderId: "SFOID2345";
readonly FulfillmentOrderStatus: "PROCESSED";
readonly FulfillmentShipment: {
readonly FulfillmentShipmentStatus: "PROCESSED";
readonly AmazonShipmentId: "ASID49535";
readonly EstimatedArrivalDateTime: "2020-07-13T19:42:04.284Z";
readonly info: {
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
};
readonly FulfillmentShipmentPackages: readonly [{
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
}, {
readonly PackageNumber: 2;
readonly CarrierCode: "1-930434";
readonly TrackingNumber: "1Z84456456573405";
}, {
readonly PackageNumber: 3;
readonly CarrierCode: "3-930434";
readonly TrackingNumber: "1Z885647654573405";
}];
};
readonly FulfillmentReturnItem: {
readonly ReceivedDateTime: "2020-07-13T19:42:04.284Z";
readonly ReturnedQuantity: 12;
readonly SellerSKU: "SELLERSKU9345";
};
};
};
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 ["FULFILLMENT_ORDER_STATUS"];
};
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 FulfillmentOrderStatusNotification: {
readonly SellerId: "A3TH9S8BH6GOGM";
readonly EventType: "TYPE3945";
readonly StatusUpdatedDateTime: "2020-07-13T19:42:04.284Z";
readonly SellerFulfillmentOrderId: "SFOID2345";
readonly FulfillmentOrderStatus: "PROCESSED";
readonly FulfillmentShipment: {
readonly FulfillmentShipmentStatus: "PROCESSED";
readonly AmazonShipmentId: "ASID49535";
readonly EstimatedArrivalDateTime: "2020-07-13T19:42:04.284Z";
readonly info: {
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
};
readonly FulfillmentShipmentPackages: readonly [{
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
}, {
readonly PackageNumber: 2;
readonly CarrierCode: "1-930434";
readonly TrackingNumber: "1Z84456456573405";
}, {
readonly PackageNumber: 3;
readonly CarrierCode: "3-930434";
readonly TrackingNumber: "1Z885647654573405";
}];
};
readonly FulfillmentReturnItem: {
readonly ReceivedDateTime: "2020-07-13T19:42:04.284Z";
readonly ReturnedQuantity: 12;
readonly SellerSKU: "SELLERSKU9345";
};
};
}];
readonly required: readonly ["FulfillmentOrderStatusNotification"];
readonly properties: {
readonly FulfillmentOrderStatusNotification: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification";
readonly type: "object";
readonly title: "The FulfillmentOrderStatusNotification schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: {};
readonly examples: readonly [{
readonly SellerId: "A3TH9S8BH6GOGM";
readonly EventType: "TYPE3945";
readonly StatusUpdatedDateTime: "2020-07-13T19:42:04.284Z";
readonly SellerFulfillmentOrderId: "SFOID2345";
readonly FulfillmentOrderStatus: "PROCESSED";
readonly FulfillmentShipment: {
readonly FulfillmentShipmentStatus: "PROCESSED";
readonly AmazonShipmentId: "ASID49535";
readonly EstimatedArrivalDateTime: "2020-07-13T19:42:04.284Z";
readonly info: {
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
};
readonly FulfillmentShipmentPackages: readonly [{
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
}, {
readonly PackageNumber: 2;
readonly CarrierCode: "1-930434";
readonly TrackingNumber: "1Z84456456573405";
}, {
readonly PackageNumber: 3;
readonly CarrierCode: "3-930434";
readonly TrackingNumber: "1Z885647654573405";
}];
};
readonly FulfillmentReturnItem: {
readonly ReceivedDateTime: "2020-07-13T19:42:04.284Z";
readonly ReturnedQuantity: 12;
readonly SellerSKU: "SELLERSKU9345";
};
}];
readonly required: readonly ["SellerId", "EventType", "StatusUpdatedDateTime", "SellerFulfillmentOrderId", "FulfillmentOrderStatus", "FulfillmentShipment", "FulfillmentReturnItem"];
readonly properties: {
readonly SellerId: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/SellerId";
readonly type: "string";
readonly title: "The SellerId schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["A3TH9S8BH6GOGM"];
};
readonly EventType: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/EventType";
readonly type: "string";
readonly title: "The EventType schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["TYPE3945"];
};
readonly StatusUpdatedDateTime: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/StatusUpdatedDateTime";
readonly type: "string";
readonly title: "The StatusUpdatedDateTime schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["2020-07-13T19:42:04.284Z"];
};
readonly SellerFulfillmentOrderId: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/SellerFulfillmentOrderId";
readonly type: "string";
readonly title: "The SellerFulfillmentOrderId schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["SFOID2345"];
};
readonly FulfillmentOrderStatus: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentOrderStatus";
readonly type: "string";
readonly title: "The FulfillmentOrderStatus schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["PROCESSED"];
};
readonly FulfillmentShipment: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment";
readonly type: "object";
readonly title: "The FulfillmentShipment schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: {};
readonly examples: readonly [{
readonly FulfillmentShipmentStatus: "PROCESSED";
readonly AmazonShipmentId: "ASID49535";
readonly EstimatedArrivalDateTime: "2020-07-13T19:42:04.284Z";
readonly info: {
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
};
readonly FulfillmentShipmentPackages: readonly [{
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
}, {
readonly PackageNumber: 2;
readonly CarrierCode: "1-930434";
readonly TrackingNumber: "1Z84456456573405";
}, {
readonly PackageNumber: 3;
readonly CarrierCode: "3-930434";
readonly TrackingNumber: "1Z885647654573405";
}];
}];
readonly required: readonly ["FulfillmentShipmentStatus", "AmazonShipmentId", "EstimatedArrivalDateTime", "info", "FulfillmentShipmentPackages"];
readonly properties: {
readonly FulfillmentShipmentStatus: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentStatus";
readonly type: "string";
readonly title: "The FulfillmentShipmentStatus schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["PROCESSED"];
};
readonly AmazonShipmentId: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/AmazonShipmentId";
readonly type: "string";
readonly title: "The AmazonShipmentId schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["ASID49535"];
};
readonly EstimatedArrivalDateTime: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/EstimatedArrivalDateTime";
readonly type: "string";
readonly title: "The EstimatedArrivalDateTime schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["2020-07-13T19:42:04.284Z"];
};
readonly FulfillmentShipmentPackages: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages";
readonly type: "array";
readonly title: "The FulfillmentShipmentPackages schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: readonly [];
readonly examples: readonly [readonly [{
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
}, {
readonly PackageNumber: 2;
readonly CarrierCode: "1-930434";
readonly TrackingNumber: "1Z84456456573405";
}]];
readonly properties: {
readonly FulfillmentShipmentPackageItem: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/properties/FulfillmentShipmentPackageItem";
readonly type: "object";
readonly title: "The info schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: {};
readonly examples: readonly [{
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
}];
readonly required: readonly ["PackageNumber", "CarrierCode", "TrackingNumber"];
readonly properties: {
readonly PackageNumber: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/info/properties/PackageNumber";
readonly type: "integer";
readonly title: "The PackageNumber schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: 0;
readonly examples: readonly [1];
};
readonly CarrierCode: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/info/properties/CarrierCode";
readonly type: "string";
readonly title: "The CarrierCode schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["2-930434"];
};
readonly TrackingNumber: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/info/properties/TrackingNumber";
readonly type: "string";
readonly title: "The TrackingNumber schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["1Z84456456573405"];
};
};
readonly additionalProperties: true;
};
};
readonly additionalItems: true;
readonly items: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/properties/FulfillmentShipmentPackageItem";
readonly anyOf: readonly [{
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0";
readonly type: "object";
readonly title: "The first anyOf schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: {};
readonly examples: readonly [{
readonly PackageNumber: 1;
readonly CarrierCode: "2-930434";
readonly TrackingNumber: "1Z84456456573405";
}];
readonly required: readonly ["PackageNumber", "CarrierCode", "TrackingNumber"];
readonly properties: {
readonly PackageNumber: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0/properties/PackageNumber";
readonly type: "integer";
readonly title: "The PackageNumber schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: 0;
readonly examples: readonly [1];
};
readonly CarrierCode: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0/properties/CarrierCode";
readonly type: "string";
readonly title: "The CarrierCode schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["2-930434"];
};
readonly TrackingNumber: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0/properties/TrackingNumber";
readonly type: "string";
readonly title: "The TrackingNumber schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["1Z84456456573405"];
};
};
readonly additionalProperties: true;
}];
};
};
};
readonly additionalProperties: true;
};
readonly FulfillmentReturnItem: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem";
readonly type: "object";
readonly title: "The FulfillmentReturnItem schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: {};
readonly examples: readonly [{
readonly ReceivedDateTime: "2020-07-13T19:42:04.284Z";
readonly ReturnedQuantity: 12;
readonly SellerSKU: "SELLERSKU9345";
}];
readonly required: readonly ["ReceivedDateTime", "ReturnedQuantity", "SellerSKU"];
readonly properties: {
readonly ReceivedDateTime: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem/properties/ReceivedDateTime";
readonly type: "string";
readonly title: "The ReceivedDateTime schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["2020-07-13T19:42:04.284Z"];
};
readonly ReturnedQuantity: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem/properties/ReturnedQuantity";
readonly type: "integer";
readonly title: "The ReturnedQuantity schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: 0;
readonly examples: readonly [12];
};
readonly SellerSKU: {
readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem/properties/SellerSKU";
readonly type: "string";
readonly title: "The SellerSKU schema";
readonly description: "An explanation about the purpose of this instance.";
readonly default: "";
readonly examples: readonly ["SELLERSKU9345"];
};
};
readonly additionalProperties: true;
};
};
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 FulfillmentOrderStatusNotification = FromSchema<typeof fulfillmentOrderStatusNotification>;