@shipengine/connect-order-source-api
Version:
This is the typescript/javascript definitions for the order source api
32 lines • 1.76 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.CancelSalesOrderItemsResponseSchema = exports.CancelSalesOrderItemsResponse = exports.CancelSalesOrderItemsResultSchema = exports.CancelSalesOrderItemsResult = void 0;
const tslib_1 = require("tslib");
const joi_1 = tslib_1.__importDefault(require("joi"));
/** @description Cancel result item */
class CancelSalesOrderItemsResult {
/** @description Identifier for the requested cancel notification */
notification_id;
/** @description An identifier provided by the order source to cancel the items on the fulfillment */
confimation_code;
/** @description Details given by the order source if the cancel action fails */
failure_reason;
/** @description Result status from the cancel action performed on the item. Only supported values are 'success' or 'failure'. */
status;
}
exports.CancelSalesOrderItemsResult = CancelSalesOrderItemsResult;
exports.CancelSalesOrderItemsResultSchema = joi_1.default.object({
notification_id: joi_1.default.string().required(),
confirmation_code: joi_1.default.string().optional().empty(),
failure_reason: joi_1.default.string().optional().empty(),
status: joi_1.default.string().required().valid('success', 'failure'),
});
/** @description A response for the cancel action that was performed on any number of sales order items */
class CancelSalesOrderItemsResponse {
results;
}
exports.CancelSalesOrderItemsResponse = CancelSalesOrderItemsResponse;
exports.CancelSalesOrderItemsResponseSchema = joi_1.default.object({
results: joi_1.default.array().required().min(1).items(exports.CancelSalesOrderItemsResultSchema),
});
//# sourceMappingURL=cancel-sales-order-items-response.js.map