Options
All
  • Public
  • Public/Protected
  • All
Menu

Module CancelOrder

Cancel a complete order or a subset of lines.

The order can be identified by an OrderID or by BackendID + BackendSystemID, the lines can be identified by an OrderLineID or by BackendID.

The result will tell you if it was successful.

Index

Properties

Optional BackendID

BackendID: undefined | string

Reference to the order that is being cancelled - required when OrderID is omitted

Optional BackendSystemID

BackendSystemID: undefined | string

Reference to the system from which the order originated - required when OrderID is omitted

Optional OrderID

OrderID: undefined | number

ID of the order that is being cancelled - required when BackendID and BackendSystemID are omitted Entity type: Order

Optional OrderLines

OrderLines: LineToCancel[]

Lines to cancel - or, if none are specified, all open lines of the order will be cancelled