@shipengine/connect-order-source-api/lib/models/sales-order-item.js

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

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SalesOrderItemSchema = exports.SalesOrderItem = void 0;
const tslib_1 = require("tslib");
const product_1 = require("./product");
const charge_1 = require("./charge");
const joi_1 = tslib_1.__importDefault(require("joi"));
/** @description An individual item in a sales order */
class SalesOrderItem {
    /** @description An ID for the line item for the vendor API */
    line_item_id;
    /** @description A description of the sales order item - which may differ from the product description */
    description;
    /** @description The product associated with this order item */
    product;
    /** @description The item quantity for this sales order item */
    quantity;
    /** @description The amount of the currency per unit */
    unit_price;
    /** @description A list of tax charges. The description can convey the jurisdiction */
    taxes;
    /** @description A list of shipping charges. */
    shipping_charges;
    /** @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;
    /** @description The url for the item being purchased */
    item_url;
    /** @description The (ISO 8601) datetime (UTC) associated with when this item was last modified @example "2021-03-31T18:21:14.858Z" */
    modified_date_time;
}
exports.SalesOrderItem = SalesOrderItem;
exports.SalesOrderItemSchema = joi_1.default.object({
    line_item_id: joi_1.default.string().optional().empty(),
    description: joi_1.default.string().required(),
    product: product_1.ProductSchema.optional(),
    quantity: joi_1.default.number().required(),
    unit_price: joi_1.default.number().optional(),
    taxes: joi_1.default.array().optional().items(charge_1.ChargeSchema),
    shipping_charges: joi_1.default.array().optional().items(charge_1.ChargeSchema),
    adjustments: joi_1.default.array().optional().items(charge_1.ChargeSchema),
    item_url: joi_1.default.string().optional(),
    modified_date_time: joi_1.default.string().optional().isoDate(),
});
//# sourceMappingURL=sales-order-item.js.map