Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 1.57 KB

File metadata and controls

25 lines (13 loc) · 1.57 KB

AutoOrderItemCancelRequest

Properties

Name Type Description Notes
appendItems List<AutoOrderItem> Specifying these items allows for an easier immutable item contact. Validation will occur before any operations take place. After the end/remove operation is successful, append these additional item(s) to the auto order. The changes will be available in the response if the expansion includes items. [optional]
autoOrderItemOid Integer Optional tiebreaker when more than one item on the auto order shares the same original_item_id. When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check). Leave unset for the common case of a unique original_item_id. For reference the order_item.item_reference_oid is the same value as auto_order_item.auto_order_item_oid UNLESS the a manual edit took place AFTER the original order was placed. [optional]
mode ModeEnum Cancellation mode. 'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting. 'remove' hard-deletes the item from the auto order. Defaults to 'end' (the less destructive option) when omitted. [optional]
noOrdersAfterDts String Date/time that will be used in an END mode (optional) [optional]

Enum: ModeEnum

Name Value
END "end"
REMOVE "remove"