Options
All
  • Public
  • Public/Protected
  • All
Menu

Module PreviewOrderFulfillment

Provides the ability to do a what-if to see how the provided OrderID would be fulfilled.

This will use the existing sheets with the ability to specify additional new sheets (by not specifying an ID) or modify an existing sheet (by providing the ID of an existing sheet).

Index

Properties

Optional CurrentTimeOverride

CurrentTimeOverride: undefined | string

Optional Order

Order: OrderModel

Optional OrderID

OrderID: undefined | number

Entity type: Order

Optional Sheets

Sheets: SheetToPreview[]

If you specify sheets they will either be used as an additional sheet to consider when calculating order fulfillment, or as a replacement for an existing sheet based on whether the ID of the sheet is provided or not.

Specifying additional sheets can be used as a 'what-if' tool; what would happen to this order if I change this sheet to do this, etc.

Optional Stock

Stock: StockModel

Optional UseCurrentFulfillments

UseCurrentFulfillments: undefined | false | true

If specified as true the fulfillment preview will base its result on fulfillments that have already been created for the order. For example if the order has already been exported to a certain supplier then the preview service will take that into account and not consider that supplier to be a fulfillment option anymore. If specified as false (the default) the service considers the order to be a clean slate for which all options are still open.