Class: OrderType

order.OrderType()

new OrderType()

Source:

Methods

(static) OrderType#getAvgOrderTime() → {Null|Number}

Get the field value The average time it takes to complete the order
Source:
Returns:
must be a long integer
Type
Null | Number

(static) OrderType#getCategories() → {Array.<base.Reference>}

Get the field value The categories of items that can be assigned to this order type
Source:
Returns:
An array of
Type
Array.<base.Reference>

(static) OrderType#getCustomerIdMethod() → {order.CustomerIdMethod}

Get the field value
Source:
Returns:
Type
order.CustomerIdMethod

(static) OrderType#getFee() → {Null|Number}

Get the field value The price of a fee added to this order type, not fully implemented at this time.
Source:
Returns:
must be a long integer
Type
Null | Number

(static) OrderType#getFilterCategories() → {Boolean}

Get the field value If set to false, then this order type includes all of the merchant's categories. Otherwise, it only contains the categories defined in the "categories" field on this object.
Source:
Returns:
Type
Boolean

(static) OrderType#getHours() → {hours.HoursSet}

Get the field value The hours this order type is available (if they differ from normal merchant hours)
Source:
Returns:
Type
hours.HoursSet

(static) OrderType#getHoursAvailable() → {order.HoursAvailable}

Get the field value
Source:
Returns:
Type
order.HoursAvailable

(static) OrderType#getId() → {String}

Get the field value Unique identifier
Source:
Returns:
Type
String

(static) OrderType#getIsDefault() → {Boolean}

Get the field value If this order type is the default
Source:
Returns:
Type
Boolean

(static) OrderType#getIsDeleted() → {Boolean}

Get the field value If this order type is deleted
Source:
Returns:
Type
Boolean

(static) OrderType#getIsHidden() → {Boolean}

Get the field value If this order type is hidden on the register
Source:
Returns:
Type
Boolean

(static) OrderType#getLabel() → {String}

Get the field value Label Key
Source:
Returns:
Type
String

(static) OrderType#getLabelKey() → {String}

Get the field value Label Key
Source:
Returns:
Type
String

(static) OrderType#getMaxOrderAmount() → {Null|Number}

Get the field value The maximum amount for an order allowed
Source:
Returns:
must be a long integer
Type
Null | Number

(static) OrderType#getMaxRadius() → {Null|Number}

Get the field value The maximum radius allowed for an order (i.e. delivery)
Source:
Returns:
must be a long integer
Type
Null | Number

(static) OrderType#getMinOrderAmount() → {Null|Number}

Get the field value The minimum amount required for an order to be placed
Source:
Returns:
must be a long integer
Type
Null | Number

(static) OrderType#getSystemOrderTypeDatabaseId() → {Number}

Get the field value The system_order_type table's database ID. Internal only. The ID mentioned above is the UUID.
Source:
Returns:
must be a long integer
Type
Number

(static) OrderType#getSystemOrderTypeId() → {String}

Get the field value Optional system order type that this order type is associated with.
Source:
Returns:
Type
String

(static) OrderType#getTaxable() → {Boolean}

Get the field value If this order type is taxable
Source:
Returns:
Type
Boolean

(static) OrderType#setAvgOrderTime(avgOrderTime)

Set the field value The average time it takes to complete the order
Parameters:
Name Type Description
avgOrderTime Null | Number must be a long integer
Source:

(static) OrderType#setCategories(categories)

Set the field value The categories of items that can be assigned to this order type
Parameters:
Name Type Description
categories Array.<base.Reference> An array of
Source:

(static) OrderType#setCustomerIdMethod(customerIdMethod)

Set the field value
Parameters:
Name Type Description
customerIdMethod order.CustomerIdMethod
Source:

(static) OrderType#setFee(fee)

Set the field value The price of a fee added to this order type, not fully implemented at this time.
Parameters:
Name Type Description
fee Null | Number must be a long integer
Source:

(static) OrderType#setFilterCategories(filterCategories)

Set the field value If set to false, then this order type includes all of the merchant's categories. Otherwise, it only contains the categories defined in the "categories" field on this object.
Parameters:
Name Type Description
filterCategories Boolean
Source:

(static) OrderType#setHours(hours)

Set the field value The hours this order type is available (if they differ from normal merchant hours)
Parameters:
Name Type Description
hours hours.HoursSet
Source:

(static) OrderType#setHoursAvailable(hoursAvailable)

Set the field value
Parameters:
Name Type Description
hoursAvailable order.HoursAvailable
Source:

(static) OrderType#setId(id)

Set the field value Unique identifier
Parameters:
Name Type Description
id String
Source:

(static) OrderType#setIsDefault(isDefault)

Set the field value If this order type is the default
Parameters:
Name Type Description
isDefault Boolean
Source:

(static) OrderType#setIsDeleted(isDeleted)

Set the field value If this order type is deleted
Parameters:
Name Type Description
isDeleted Boolean
Source:

(static) OrderType#setIsHidden(isHidden)

Set the field value If this order type is hidden on the register
Parameters:
Name Type Description
isHidden Boolean
Source:

(static) OrderType#setLabel(label)

Set the field value Label Key
Parameters:
Name Type Description
label String
Source:

(static) OrderType#setLabelKey(labelKey)

Set the field value Label Key
Parameters:
Name Type Description
labelKey String
Source:

(static) OrderType#setMaxOrderAmount(maxOrderAmount)

Set the field value The maximum amount for an order allowed
Parameters:
Name Type Description
maxOrderAmount Null | Number must be a long integer
Source:

(static) OrderType#setMaxRadius(maxRadius)

Set the field value The maximum radius allowed for an order (i.e. delivery)
Parameters:
Name Type Description
maxRadius Null | Number must be a long integer
Source:

(static) OrderType#setMinOrderAmount(minOrderAmount)

Set the field value The minimum amount required for an order to be placed
Parameters:
Name Type Description
minOrderAmount Null | Number must be a long integer
Source:

(static) OrderType#setSystemOrderTypeDatabaseId(systemOrderTypeDatabaseId)

Set the field value The system_order_type table's database ID. Internal only. The ID mentioned above is the UUID.
Parameters:
Name Type Description
systemOrderTypeDatabaseId Number must be a long integer
Source:

(static) OrderType#setSystemOrderTypeId(systemOrderTypeId)

Set the field value Optional system order type that this order type is associated with.
Parameters:
Name Type Description
systemOrderTypeId String
Source:

(static) OrderType#setTaxable(taxable)

Set the field value If this order type is taxable
Parameters:
Name Type Description
taxable Boolean
Source: