UNPKG

@shipengine/connect-order-source-api

Version:

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

31 lines (30 loc) 1.38 kB
import { RequestBase } from './request-base'; /** @description Requested cancel item(s) notification */ export declare class CancelSalesOrderItemsNotification { /** @description Identifier for the requested cancel notification */ notification_id: string; /** @description Unique order identifier from the order source */ order_id: string; /** @description Items the action should be applied to */ items: RequestedCancelItem[]; } /** @description Details about the requested item to cancel */ export declare class RequestedCancelItem { /** @description Line item idenifier provided by the order source */ line_item_id: string; /** @decription Message that the shipper can provide about the action being performed on the item */ message?: string; /** @description Quantity of the item */ quantity: number; /** @description Product information about the item */ product?: RequestedCancelProduct; } /** @description Product details about the requested item to cancel */ export declare class RequestedCancelProduct { /** @description Product identifier provided by the order source */ product_id?: string; } /** @description A request to cancel a number of sales order items in a sales order*/ export declare class CancelSalesOrderItemsRequest extends RequestBase { notifications: CancelSalesOrderItemsNotification[]; }