Skip to content

Selection Definition

Attribute Type Read Only Description
id int true Selection ID.
machineId int true Link to Machine. Required. Must be greater than or equal to zero.
productId int? false Link to the Product in the selection. Must be null, -1, or greater than zero.
price decimal false The price of the selection. Must be greater than zero.
invoicePrice decimal false If invoicing is enabled, cost added per product in selection to the invoice. Must be greater than zero.
restockTo int false The level to which a selection should be restocked to. Must be Must be greater than or equal to restockAt and less than or equal to depth.
depth int false The maximum quantity of product the selection can hold.
count int false The quantity of product currently in the selection.
isActive bool true Determines if the selection is active. Primarily indicates if we believe there may be a problem with the motor for this selection.
alertLevel int false Level at which an alert will be generated. Must be greater than or equal to zero and less than or equal to restockAt.
restockAt int false The level at which product should be restocked. Must be greater than or equal to alertLevel and less than or equal to restockTo.
freeCount int false The quantity of product available in selection to be dispensed for free. Must be greater than or equal to zero.
tax decimal? false Tax percentage, only applied if machine.useMachineTaxRate is false and organization.ChargeTax is true. Must be greater than or equal to zero.
commission decimal false Commission percentage, only applied if machine.useMachineCommissionRate is false. Must be greater than or equal to zero.
selectionNumber string false Hardware based selection identifier. Must be greater than or equal to zero and unique within the specified machine.
friendlyNumber string true Custom mapping for selectionNumber (such as A1).

Delta Definition

Attribute Type Description
selectionId int The selection the delta will be applied to. Must be greater than equal to one.
delta int The delta to apply to the selection count. Negative numbers will remove count from that selection.