@shipengine/connect-order-source-api
Version:
This is the typescript/javascript definitions for the order source api
36 lines • 1.85 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.AcknowledgeOrdersRequestSchema = exports.AcknowledgeOrdersRequest = exports.OrderAcknowledgementSchema = exports.OrderAcknowledgement = void 0;
const tslib_1 = require("tslib");
const joi_1 = tslib_1.__importDefault(require("joi"));
const request_base_1 = require("./request-base");
/**
* @description This is a request for acknowledging that an order has been imported
*/
class OrderAcknowledgement {
/** @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 (ISO 8601) datetime (UTC) of when the order was imported @example "2021-03-31T18:21:14.858Z" */
imported_date;
/** @description Data provided by the order source that was included in the ExportSalesOrder response */
integration_context;
}
exports.OrderAcknowledgement = OrderAcknowledgement;
exports.OrderAcknowledgementSchema = joi_1.default.object({
order_id: joi_1.default.string().required(),
order_number: joi_1.default.string().optional(),
imported_date: joi_1.default.string().required(),
integration_context: joi_1.default.string().optional(),
});
/** @description This is a request for acknowledging that an order has been imported */
class AcknowledgeOrdersRequest extends request_base_1.RequestBase {
/** @description A list of orders needing to be acknowledged in order to successfully be imported into our system. */
orders;
}
exports.AcknowledgeOrdersRequest = AcknowledgeOrdersRequest;
exports.AcknowledgeOrdersRequestSchema = joi_1.default.object({
orders: joi_1.default.array().items(exports.OrderAcknowledgementSchema).required(),
});
//# sourceMappingURL=acknowledge-orders-request.js.map