@shipengine/connect-fulfillment-provider-api 0.1.0

package/lib/models/order-source/index.d.ts

@@ -0,0 +1,12 @@
+export * from './address';
+export * from './bill-to';
+export * from './buyer';
+export * from './charge';
+export * from './note';
+export * from './payment';
+export * from './product';
+export * from './sales-order';
+export * from './sales-order-item';
+export * from './shipping-preferences';
+export * from './weight';
+export * from './shipment-notification';

package/lib/models/order-source/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./address"), exports);
+__exportStar(require("./bill-to"), exports);
+__exportStar(require("./buyer"), exports);
+__exportStar(require("./charge"), exports);
+__exportStar(require("./note"), exports);
+__exportStar(require("./payment"), exports);
+__exportStar(require("./product"), exports);
+__exportStar(require("./sales-order"), exports);
+__exportStar(require("./sales-order-item"), exports);
+__exportStar(require("./shipping-preferences"), exports);
+__exportStar(require("./weight"), exports);
+__exportStar(require("./shipment-notification"), exports);
+//# sourceMappingURL=index.js.map

package/lib/models/order-source/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/order-source/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,4CAA0B;AAC1B,0CAAwB;AACxB,2CAAyB;AACzB,yCAAuB;AACvB,4CAA0B;AAC1B,4CAA0B;AAC1B,gDAA8B;AAC9B,qDAAmC;AACnC,yDAAuC;AACvC,2CAAyB;AACzB,0DAAwC"}

package/lib/models/order-source/label-voucher.d.ts

@@ -0,0 +1,7 @@
+/** @description Represents information needed to leverage a third party Carrier API implementation */
+export interface LabelVoucher {
+    /** @description Base URL for the Carrier API implementation */
+    url?: string;
+    /** @description Token needed to authenticate with the Carrier API implementation */
+    token?: string;
+}

package/lib/models/order-source/label-voucher.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=label-voucher.js.map

package/lib/models/order-source/label-voucher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"label-voucher.js","sourceRoot":"","sources":["../../../src/models/order-source/label-voucher.ts"],"names":[],"mappings":""}

package/lib/models/order-source/note.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @description The standardized type associated with a note
+ */
+export declare enum NoteType {
+    BackOrderMessage = "BackOrderMessage",
+    ConditionNote = "ConditionNote",
+    GiftMessage = "GiftMessage",
+    InternalNotes = "InternalNotes",
+    InStockMessage = "InStockMessage",
+    MPN = "MPN",
+    NotesFromBuyer = "NotesFromBuyer",
+    NotesToBuyer = "NotesToBuyer",
+    Other = "Other",
+    OutOfStockMessage = "OutOfStockMessage",
+    Reason = "Reason",
+    SpecialInstructions = "SpecialInstructions",
+    WarningLabel = "WarningLabel",
+    FeedbackMessage = "FeedbackMessage"
+}
+/**
+ * @description This represents a note to the buyer, seller, or recipient
+ */
+export interface Note {
+    /** @description The type of note being sent */
+    type: NoteType;
+    /** @description The contents of the note */
+    text: string;
+}

package/lib/models/order-source/note.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoteType = void 0;
+/**
+ * @description The standardized type associated with a note
+ */
+var NoteType;
+(function (NoteType) {
+    NoteType["BackOrderMessage"] = "BackOrderMessage";
+    NoteType["ConditionNote"] = "ConditionNote";
+    NoteType["GiftMessage"] = "GiftMessage";
+    NoteType["InternalNotes"] = "InternalNotes";
+    NoteType["InStockMessage"] = "InStockMessage";
+    NoteType["MPN"] = "MPN";
+    NoteType["NotesFromBuyer"] = "NotesFromBuyer";
+    NoteType["NotesToBuyer"] = "NotesToBuyer";
+    NoteType["Other"] = "Other";
+    NoteType["OutOfStockMessage"] = "OutOfStockMessage";
+    NoteType["Reason"] = "Reason";
+    NoteType["SpecialInstructions"] = "SpecialInstructions";
+    NoteType["WarningLabel"] = "WarningLabel";
+    NoteType["FeedbackMessage"] = "FeedbackMessage";
+})(NoteType = exports.NoteType || (exports.NoteType = {}));
+//# sourceMappingURL=note.js.map

package/lib/models/order-source/note.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"note.js","sourceRoot":"","sources":["../../../src/models/order-source/note.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,QAeX;AAfD,WAAY,QAAQ;IAClB,iDAAqC,CAAA;IACrC,2CAA+B,CAAA;IAC/B,uCAA2B,CAAA;IAC3B,2CAA+B,CAAA;IAC/B,6CAAiC,CAAA;IACjC,uBAAW,CAAA;IACX,6CAAiC,CAAA;IACjC,yCAA6B,CAAA;IAC7B,2BAAe,CAAA;IACf,mDAAuC,CAAA;IACvC,6BAAiB,CAAA;IACjB,uDAA2C,CAAA;IAC3C,yCAA6B,CAAA;IAC7B,+CAAmC,CAAA;AACrC,CAAC,EAfW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAenB"}

package/lib/models/order-source/packing-slip.d.ts

@@ -0,0 +1,5 @@
+/** @description Packing slip details for a fulfillment brand */
+export interface PackingSlip {
+    /** @description The url from which the packing slip can be downloaded */
+    url?: string;
+}

package/lib/models/order-source/packing-slip.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=packing-slip.js.map

package/lib/models/order-source/packing-slip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packing-slip.js","sourceRoot":"","sources":["../../../src/models/order-source/packing-slip.ts"],"names":[],"mappings":""}

package/lib/models/order-source/payment.d.ts

@@ -0,0 +1,32 @@
+import { Charge } from './charge';
+import { LabelVoucher } from './label-voucher';
+/** @description The status of whether or not an order has been paid for */
+export declare enum PaymentStatus {
+    AwaitingPayment = "AwaitingPayment",
+    PaymentCancelled = "PaymentCancelled",
+    PaymentFailed = "PaymentFailed",
+    PaymentInProcess = "PaymentInProcess",
+    Paid = "Paid",
+    Other = "Other"
+}
+/** @description This represents a payment made for an order */
+export interface Payment {
+    /** @description An ID for this payment in the vendor API */
+    payment_id?: string;
+    /** @description The status of whether or not an order has been paid for */
+    payment_status?: PaymentStatus;
+    /** @description A list of tax charges. The description can convey the jurisdiction */
+    taxes?: Charge[];
+    /** @description A list of shipping charges. */
+    shipping_charges?: Charge[];
+    /** @description A list of adjustments applied that influence the order total. For example, promotions/discounts/coupons. The amount should always be a quantity of currency, not a percentage. */
+    adjustments?: Charge[];
+    /** @description The amount of the currency */
+    amount_paid?: number;
+    /** @description Coupon codes applied to obtain a discount. The discount amounts should be included as one of the adjustments. */
+    coupon_code?: string[];
+    /** @description The payment method */
+    payment_method?: string;
+    /** @description Represents information needed to leverage a third party Carrier API implementation */
+    label_voucher?: LabelVoucher;
+}

package/lib/models/order-source/payment.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentStatus = void 0;
+/** @description The status of whether or not an order has been paid for */
+var PaymentStatus;
+(function (PaymentStatus) {
+    PaymentStatus["AwaitingPayment"] = "AwaitingPayment";
+    PaymentStatus["PaymentCancelled"] = "PaymentCancelled";
+    PaymentStatus["PaymentFailed"] = "PaymentFailed";
+    PaymentStatus["PaymentInProcess"] = "PaymentInProcess";
+    PaymentStatus["Paid"] = "Paid";
+    PaymentStatus["Other"] = "Other";
+})(PaymentStatus = exports.PaymentStatus || (exports.PaymentStatus = {}));
+//# sourceMappingURL=payment.js.map

package/lib/models/order-source/payment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment.js","sourceRoot":"","sources":["../../../src/models/order-source/payment.ts"],"names":[],"mappings":";;;AAGA,2EAA2E;AAC3E,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,oDAAmC,CAAA;IACnC,sDAAqC,CAAA;IACrC,gDAA+B,CAAA;IAC/B,sDAAqC,CAAA;IACrC,8BAAa,CAAA;IACb,gCAAe,CAAA;AACjB,CAAC,EAPW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAOxB"}

package/lib/models/order-source/product.d.ts

@@ -0,0 +1,56 @@
+import { Weight } from './weight';
+import { Dimensions } from '../units';
+/** @description A set of identifiers for a product */
+export interface ProductIdentifiers {
+    /** @description A stock-keeping unit associated with a product by the order source */
+    sku?: string;
+    /** @description A universal product code associated with a product */
+    upc?: string;
+    /** @description An international standard book number associated with a product */
+    isbn?: string;
+    /** @description An Amzon standard identification number associated with a product */
+    asin?: string;
+    /** @description A stock-keeping unit associated with the fulfillment of an order */
+    fulfillment_sku?: string;
+    /** @description The identifier needed to set and retrieve inventory levels */
+    inventory_id?: string;
+}
+/** @description Details about a product @example { name: "Color", value: "Red" } */
+export interface ProductDetail {
+    /** @description The type of the product detail. Example (non-exhaustive) values: 'Color', 'CountryOfManufacture', 'Shape', 'Size', 'Style' */
+    name: string;
+    /** @description The value of the product detail */
+    value: string;
+}
+/** @description The urls associated with a product */
+export interface ProductUrls {
+    /** @description A link to the product page if available */
+    product_url?: string;
+    /** @description A link to the image for a product if available */
+    image_url?: string;
+    /** @description A link to the image for use in platform thumbnails */
+    thumbnail_url?: string;
+}
+/** @description This represents a product */
+export interface Product {
+    /** @description This ID of this product in the vendor API */
+    product_id: string;
+    /** @description The product name */
+    name: string;
+    /** @description The product description */
+    description?: string;
+    /** @description Additional identifiers associated with this product */
+    identifiers?: ProductIdentifiers;
+    /** @description A list of details associated with this product */
+    details?: ProductDetail[];
+    /** @description The cost of a single product */
+    unit_cost?: number;
+    /** @description The weight of the product */
+    weight?: Weight;
+    /** @description The dimensions of the product */
+    dimensions?: Dimensions;
+    /** @description The urls associated with a product */
+    urls?: ProductUrls;
+    /** @description The location the product can be found in a warehouse */
+    location?: string;
+}

package/lib/models/order-source/product.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=product.js.map

package/lib/models/order-source/product.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"product.js","sourceRoot":"","sources":["../../../src/models/order-source/product.ts"],"names":[],"mappings":""}

package/lib/models/order-source/sales-order-item.d.ts

@@ -0,0 +1,27 @@
+import { Product } from './product';
+import { Charge } from './charge';
+/** @description An individual item in a sales order */
+export interface SalesOrderItem {
+    /** @description An ID for the line item for the vendor API */
+    line_item_id?: string;
+    /** @description A description of the sales order item - which may differ from the product description */
+    description: string;
+    /** @description The product associated with this order item */
+    product?: Product;
+    /** @description The item quantity for this sales order item */
+    quantity: number;
+    /** @description The amount of the currency per unit */
+    unit_price?: number;
+    /** @description The amount of the currency for customs to be paid per unit */
+    declared_value?: number;
+    /** @description A list of tax charges. The description can convey the jurisdiction */
+    taxes?: Charge[];
+    /** @description A list of shipping charges. */
+    shipping_charges?: Charge[];
+    /** @description A list of adjustments applied that influence the order total. For example, promotions/discounts/coupons. The amount should always be a quantify of currency, not a percentage. */
+    adjustments?: Charge[];
+    /** @description The url for the item being purchased */
+    item_url?: string;
+    /** @description The (ISO 8601) datetime (UTC) associated with when this item was last modified @example "2021-03-31T18:21:14.858Z" */
+    modified_date_time?: string;
+}

package/lib/models/order-source/sales-order-item.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sales-order-item.js.map

package/lib/models/order-source/sales-order-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sales-order-item.js","sourceRoot":"","sources":["../../../src/models/order-source/sales-order-item.ts"],"names":[],"mappings":""}

package/lib/models/order-source/sales-order.d.ts

@@ -0,0 +1,87 @@
+import { Address } from './address';
+import { ShippingPreferences } from './shipping-preferences';
+import { SalesOrderItem } from './sales-order-item';
+import { Buyer } from './buyer';
+import { BillTo } from './bill-to';
+import { Payment } from './payment';
+import { Note } from './note';
+import { Branding } from './branding';
+/** @description The status of a sales order */
+export declare enum SalesOrderStatus {
+    AwaitingPayment = "AwaitingPayment",
+    AwaitingShipment = "AwaitingShipment",
+    Cancelled = "Cancelled",
+    Completed = "Completed",
+    OnHold = "OnHold",
+    PendingFulfillment = "PendingFulfillment"
+}
+/** @description Represents information from the source marketplace. (This is common with reselling goods) */
+export interface OriginalOrderSource {
+    /** @description A unique identifier for the source marketplace */
+    source_id?: string;
+    /** @description The code for the type of marketplace */
+    marketplace_code?: string;
+    /** @description The unique identifier for the order at the source marketplace */
+    order_id?: string;
+}
+/** @description Additional information necessary for a requested fulfillment */
+export interface RequestedFulfillmentExtensions {
+    /** @description Custom field 1 */
+    custom_field_1?: string;
+    /** @description Custom field 2 */
+    custom_field_2?: string;
+    /** @description Custom field 3 */
+    custom_field_3?: string;
+}
+/** @description The fulfillment requested by the marketplace or the buyer */
+export interface RequestedFulfillment {
+    /** @description Identifier for the requested fulfillment from the order source */
+    requested_fulfillment_id?: string;
+    /** @description Who the order should be shipped to */
+    ship_to: Address;
+    /** @description The items that should be shipped */
+    items: SalesOrderItem[];
+    /** @description Additional information about this fulfillment */
+    extensions?: RequestedFulfillmentExtensions;
+    /** @description Preferences about how the order is shipped */
+    shipping_preferences?: ShippingPreferences;
+    /** @description Brand information about this fulfillment */
+    branding?: Branding;
+}
+/** @description This represents a sales order */
+export interface SalesOrder {
+    /** @description The unique identifier of the sales order from the order source */
+    order_id: string;
+    /** @description The customer facing identifier of the sales order */
+    order_number?: string;
+    /** @description The sales order status */
+    status: SalesOrderStatus;
+    /** @description The (ISO 8601) datetime (UTC) associated with when this sales order was paid for @example "2021-03-31T18:21:14.858Z" */
+    paid_date?: string;
+    /** @description The (ISO 8601) datetime (UTC) associated with when this order shipped @example "2021-03-31T18:21:14.858Z" */
+    fulfilled_date?: string;
+    /** @description Represents information from the source marketplace. (This is common with reselling goods) */
+    original_order_source?: OriginalOrderSource;
+    /** @description The fulfillment requested by the marketplace or the buyer */
+    requested_fulfillments: RequestedFulfillment[];
+    /** @description The buyer of this sales order */
+    buyer?: Buyer;
+    /** @description The person being billed for this sales order */
+    bill_to?: BillTo;
+    /** @description The three character ISO 4217 code of the currency used for all monetary amounts @example "USD", "EUR", "NZD" */
+    currency?: string;
+    /** @description Information about the payment */
+    payment?: Payment;
+    /** @description The source that the order is shipping from */
+    ship_from?: Address;
+    /** @description A unique url associated with the order */
+    order_url?: string;
+    /** @description Notes about the order */
+    notes?: Note[];
+    /** @description Data provided by the order source that should be included in calls back to the order source. This data is only meaningful to the integration and not otherwise used by the platform. */
+    integration_context?: string;
+    /** @description The (ISO 8601) datetime (UTC) associated with when this order was created @example "2021-03-31T18:21:14.858Z" */
+    created_date_time?: string;
+    /** @description The (ISO 8601) datetime (UTC) associated with when this order was last modified @example "2021-03-31T18:21:14.858Z" */
+    modified_date_time?: string;
+}

package/lib/models/order-source/sales-order.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SalesOrderStatus = void 0;
+/** @description The status of a sales order */
+var SalesOrderStatus;
+(function (SalesOrderStatus) {
+    SalesOrderStatus["AwaitingPayment"] = "AwaitingPayment";
+    SalesOrderStatus["AwaitingShipment"] = "AwaitingShipment";
+    SalesOrderStatus["Cancelled"] = "Cancelled";
+    SalesOrderStatus["Completed"] = "Completed";
+    SalesOrderStatus["OnHold"] = "OnHold";
+    SalesOrderStatus["PendingFulfillment"] = "PendingFulfillment";
+})(SalesOrderStatus = exports.SalesOrderStatus || (exports.SalesOrderStatus = {}));
+//# sourceMappingURL=sales-order.js.map

package/lib/models/order-source/sales-order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sales-order.js","sourceRoot":"","sources":["../../../src/models/order-source/sales-order.ts"],"names":[],"mappings":";;;AASA,+CAA+C;AAC/C,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,uDAAmC,CAAA;IACnC,yDAAqC,CAAA;IACrC,2CAAuB,CAAA;IACvB,2CAAuB,CAAA;IACvB,qCAAiB,CAAA;IACjB,6DAAyC,CAAA;AAC3C,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B"}

package/lib/models/order-source/shipment-notification.d.ts

@@ -0,0 +1,55 @@
+import { Address, Note } from '.';
+/** @description  */
+export interface ShipmentNotificationItem {
+    /** @description The order source's unique identifier for the line item */
+    line_item_id?: string;
+    /** @description A description of the sales order item - which may differ from the product description */
+    description: string;
+    /** @description The unique identifier for the item that was shipped */
+    sku?: string;
+    /** @description This ID of this product in the vendor API */
+    product_id?: string;
+    /** @description The number of items of this SKU that were shipped */
+    quantity: number;
+}
+/** @description An individual notification that an order has been shipped */
+export interface ShipmentNotification {
+    /** @description A unique identifier to correlate this shipment notification with its result in the response */
+    notification_id: string;
+    /** @description The unique identifier of the sales order from the order source */
+    order_id: string;
+    /** @description The customer facing identifier of the sales order */
+    order_number?: string;
+    /** @description The identifier provided by the fulfiller for tracking the delivery progress */
+    tracking_number?: string;
+    /** @description The url where the shipment can be tracked */
+    tracking_url?: string;
+    /** @description The carrier code the order was shipped through */
+    carrier_code?: string;
+    /** @description The shipping service used to ship this order */
+    carrier_service_code?: string;
+    /** @description The order source's identifier for the location that items were shipped from */
+    ext_location_id?: string;
+    /** @description The items shipped in this shipment */
+    items: ShipmentNotificationItem[];
+    /** @description Where the shipment was shipped to */
+    ship_to?: Address;
+    /** @description Where the shipment shipped from */
+    ship_from?: Address;
+    /** @description The return address specified on the shipment */
+    return_address?: Address;
+    /** @description The (ISO 8601) datetime (UTC) associated with when this item was last modified @example "2021-03-31T18:21:14.858Z" */
+    ship_date?: string;
+    /** @description The (ISO 4217) code describing the currency used for all amounts on this payload. @example "USD", "EUR", "NZD" */
+    currency?: string;
+    /** @description The amount of money it cost to fulfill this shipment */
+    fulfillment_cost?: number;
+    /** @description Additional notes associated with this notification or its sales order */
+    notes?: Note[];
+    /** @description The total amount of insurance purchased */
+    insurance_cost?: number;
+    /** @description Indicates whether or not the buyer should be notified that this item has been shipped */
+    notify_buyer?: boolean;
+    /** @description The integration context specified on the ExportSalesOrders response */
+    integration_context: any;
+}

package/lib/models/order-source/shipment-notification.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shipment-notification.js.map

package/lib/models/order-source/shipment-notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipment-notification.js","sourceRoot":"","sources":["../../../src/models/order-source/shipment-notification.ts"],"names":[],"mappings":""}

package/lib/models/order-source/shipping-preferences.d.ts

@@ -0,0 +1,52 @@
+import { Document } from '../documents';
+/** @description This represents the shipping preferences specified for an order */
+export interface ShippingPreferences {
+    /** @description Indicates whether or not the item being delivered is a digital good or not */
+    digital_fulfillment?: boolean;
+    /** @description Indicates whether or not this shipment will require additional handling */
+    additional_handling?: boolean;
+    /** @description Indicates whether duties should be billed to the sender of the package */
+    bill_duties_to_sender?: boolean;
+    /** @description Indicates whether you must pay for postage at drop off, for carriers that usually require prepaid postage. */
+    do_not_prepay_postage?: boolean;
+    /** @description Indicates whether or not this order is a gift */
+    gift?: boolean;
+    /** @description Indicates whether or not this order contains alcohol */
+    has_alcohol?: boolean;
+    /** @description Indicates whether or not insurance has been requested for shipping this order */
+    insurance_requested?: boolean;
+    /** @description Indicates whether or not this order is nonmachinable (must be sorted outside of the standard, automated mail process) */
+    non_machinable?: boolean;
+    /** @description Indicates whether or not this order should be delivered on a saturday */
+    saturday_delivery?: boolean;
+    /** @description Indicates whether or not to allow display of postage paid on the shipping label */
+    show_postage?: boolean;
+    /** @description Indicates whether or not to supress email notifications to the buyer */
+    suppress_email_notify?: boolean;
+    /** @description Indicates whether or not to supress email notifications to the seller */
+    suppress_marketplace_notify?: boolean;
+    /** @description The (ISO 8601) datetime (UTC) associated with when the order needs to be delivered by @example "2021-03-31T18:21:14.858Z" */
+    deliver_by_date?: string;
+    /** @description The (ISO 8601) datetime (UTC) associated with how long to hold the order @example "2021-03-31T18:21:14.858Z" */
+    hold_until_date?: string;
+    /** @description The (ISO 8601) datetime (UTC) associated with when the order is ready to ship @example "2021-03-31T18:21:14.858Z" */
+    ready_to_ship_date?: string;
+    /** @description The (ISO 8601) datetime (UTC) associated with when the order needs to be shipped by @example "2021-03-31T18:21:14.858Z" */
+    ship_by_date?: string;
+    /** @description The identifer assigned by a fulfillment planning system at checkout (Delivery Options). */
+    preplanned_fulfillment_id?: string;
+    /** @description The requested shipping service for this fulfillment */
+    shipping_service?: string;
+    /** @description The requested package type for this fulfillment */
+    package_type?: string;
+    /** @description The amount of money being request for insurance on this shipment */
+    insured_value?: number;
+    /** @description true if the order was placed under the terms of the order source's premium program (Amazon Prime, Walmart+, etc) */
+    is_premium_program?: boolean;
+    /** @description The name of the premium program, if any. This is for informational purposes. Consumers should base all logic on is_premium_program flag. */
+    premium_program_name?: string;
+    /** @description The warehouse name associated with the requested warehouse  */
+    requested_warehouse?: string;
+    /** @description Any documents relevant to shipping that the order source provides */
+    documents?: Document[];
+}

package/lib/models/order-source/shipping-preferences.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shipping-preferences.js.map

package/lib/models/order-source/shipping-preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-preferences.js","sourceRoot":"","sources":["../../../src/models/order-source/shipping-preferences.ts"],"names":[],"mappings":""}

package/lib/models/order-source/weight.d.ts

@@ -0,0 +1,8 @@
+import { WeightUnit } from '../units';
+/** @description A measurement of weight */
+export interface Weight {
+    /** @description The unit this weight was measured in */
+    unit: WeightUnit;
+    /** @description The value of the weight in weight units */
+    value: number;
+}

package/lib/models/order-source/weight.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=weight.js.map

package/lib/models/order-source/weight.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weight.js","sourceRoot":"","sources":["../../../src/models/order-source/weight.ts"],"names":[],"mappings":""}

package/lib/models/sales-order-status-change.d.ts

@@ -0,0 +1,22 @@
+import { ShipmentNotification } from '.';
+export declare type SalesOrderStatusChange = {
+    order_id: string;
+    status?: SalesOrderShippingStatus;
+    items?: [
+        {
+            line_item_id: string;
+            sku: string;
+            quantity: number;
+            shipped_quantity: number;
+            cancelled_quantity: QuantityWithReason;
+            rejected_quantity: QuantityWithReason;
+            unknown_quantity: QuantityWithReason;
+        }
+    ];
+    shipments: ShipmentNotification[];
+};
+export declare type SalesOrderShippingStatus = 'processing' | 'cancelled' | 'rejected' | 'unknown' | 'partially_shipped' | 'shipped';
+export declare type QuantityWithReason = {
+    value: number;
+    reason: string;
+};

package/lib/models/sales-order-status-change.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sales-order-status-change.js.map

package/lib/models/sales-order-status-change.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sales-order-status-change.js","sourceRoot":"","sources":["../../src/models/sales-order-status-change.ts"],"names":[],"mappings":""}

package/lib/models/units/dimension-details.d.ts

@@ -0,0 +1,9 @@
+import { Dimensions } from './dimensions';
+import { DimensionUnit } from './dimension-unit';
+/** @description Basic structure for package dimensions */
+export interface DimensionDetails {
+    dimensions_in_centimeters?: Dimensions;
+    dimensions_in_inches?: Dimensions;
+    source_dimensions?: Dimensions;
+    source_dimension_unit: DimensionUnit;
+}

package/lib/models/units/dimension-details.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dimension-details.js.map

package/lib/models/units/dimension-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimension-details.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details.ts"],"names":[],"mappings":""}

package/lib/models/units/dimension-unit.d.ts

@@ -0,0 +1,5 @@
+/** @description Unit of measurement for dimensions */
+export declare enum DimensionUnit {
+    Inches = "inches",
+    Centimeters = "centimeters"
+}

package/lib/models/units/dimension-unit.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DimensionUnit = void 0;
+/** @description Unit of measurement for dimensions */
+var DimensionUnit;
+(function (DimensionUnit) {
+    DimensionUnit["Inches"] = "inches";
+    DimensionUnit["Centimeters"] = "centimeters";
+})(DimensionUnit = exports.DimensionUnit || (exports.DimensionUnit = {}));
+//# sourceMappingURL=dimension-unit.js.map

package/lib/models/units/dimension-unit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimension-unit.js","sourceRoot":"","sources":["../../../src/models/units/dimension-unit.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,4CAA2B,CAAA;AAC7B,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB"}

package/lib/models/units/dimensions.d.ts

@@ -0,0 +1,6 @@
+/** @description Basic structure for dimensions */
+export interface Dimensions {
+    length?: number;
+    width?: number;
+    height?: number;
+}

package/lib/models/units/dimensions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dimensions.js.map