@shipengine/connect-order-source-api/lib/requests/shipment-notification-request.js

This is the typescript/javascript definitions for the order source api

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ShipmentNotificationRequest = exports.ShipmentNotification = exports.ShipmentNotificationItem = void 0;
const request_base_1 = require("./request-base");
/** @description  */
class ShipmentNotificationItem {
    /** @description The order source's unique identifier for the line item */
    line_item_id;
    /** @description A description of the sales order item - which may differ from the product description */
    description;
    /** @description The unique identifier for the item that was shipped */
    sku;
    /** @description This ID of this product in the vendor API */
    product_id;
    /** @description The number of items of this SKU that were shipped */
    quantity;
}
exports.ShipmentNotificationItem = ShipmentNotificationItem;
/** @description An individual notification that an order has been shipped */
class ShipmentNotification {
    /** @description A unique identifier to correlate this shipment notification with its result in the response */
    notification_id;
    /** @description The unique identifier of the sales order from the order source */
    order_id;
    /** @description The customer facing identifier of the sales order */
    order_number;
    /** @description The identifier provided by the fulfiller for tracking the delivery progress */
    tracking_number;
    /** @description The url where the shipment can be tracked */
    tracking_url;
    /** @description The carrier code the order was shipped through */
    carrier_code;
    /** @description The shipping service used to ship this order */
    carrier_service_code;
    /** @description The order source's identifier for the location that items were shipped from */
    ext_location_id;
    /** @description The items shipped in this shipment */
    items;
    /** @description Where the shipment was shipped to */
    ship_to;
    /** @description Where the shipment shipped from */
    ship_from;
    /** @description The return address specified on the shipment */
    return_address;
    /** @description The (ISO 8601) datetime (UTC) associated with when this item was last modified @example "2021-03-31T18:21:14.858Z" */
    ship_date;
    /** @description The (ISO 4217) code describing the currency used for all amounts on this payload. @example "USD", "EUR", "NZD" */
    currency;
    /** @description The amount of money it cost to fulfill this shipment */
    fulfillment_cost;
    /** @description Additional notes associated with this notification or its sales order */
    notes;
    /** @description The total amount of insurance purchased */
    insurance_cost;
    /** @description Indicates whether or not the buyer should be notified that this item has been shipped */
    notify_buyer;
    /** @description The integration context specified on the ExportSalesOrders response */
    integration_context;
}
exports.ShipmentNotification = ShipmentNotification;
/** @description A request to notify an order source that a order has been shipped */
class ShipmentNotificationRequest extends request_base_1.RequestBase {
    /** @description A list of orders to notify the order source about */
    notifications;
}
exports.ShipmentNotificationRequest = ShipmentNotificationRequest;
//# sourceMappingURL=shipment-notification-request.js.map