@shipengine/connect-order-source-api
Version:
This is the typescript/javascript definitions for the order source api
21 lines (20 loc) • 1.04 kB
TypeScript
import Joi from 'joi';
type Status = 'success' | 'failure';
/** @description Cancel result item */
export declare class CancelSalesOrderItemsResult {
/** @description Identifier for the requested cancel notification */
notification_id: string;
/** @description An identifier provided by the order source to cancel the items on the fulfillment */
confimation_code?: string;
/** @description Details given by the order source if the cancel action fails */
failure_reason?: string;
/** @description Result status from the cancel action performed on the item. Only supported values are 'success' or 'failure'. */
status: Status;
}
export declare const CancelSalesOrderItemsResultSchema: Joi.ObjectSchema<any>;
/** @description A response for the cancel action that was performed on any number of sales order items */
export declare class CancelSalesOrderItemsResponse {
results: CancelSalesOrderItemsResult[];
}
export declare const CancelSalesOrderItemsResponseSchema: Joi.ObjectSchema<any>;
export {};