Create Order Type For Merchant

post

https://apisandbox.dev.clover.com/v3/merchants/{mId}/order_types

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mId

string

required

Merchant Id

Query Params

expand

string

Expandable fields: [hours, attributes, categories]

Body Params

string

Unique identifier

labelKey

string

Label Key

label

string

Label Key

taxable

boolean

Defaults to false

If this order type is taxable

isDefault

boolean

Defaults to false

If this order type is the default

filterCategories

boolean

Defaults to false

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.

isHidden

boolean

Defaults to false

If this order type is hidden on the register

fee

integer

The price of a fee added to this order type, not fully implemented at this time.

minOrderAmount

integer

The minimum amount required for an order to be placed

maxOrderAmount

integer

The maximum amount for an order allowed

maxRadius

integer

The maximum radius allowed for an order (i.e. delivery)

avgOrderTime

integer

The average time it takes to complete the order

hoursAvailable

string

enum

Allowed:

customerIdMethod

string

enum

Allowed:

isDeleted

boolean

Defaults to false

If this order type is deleted

systemOrderTypeId

string

Optional system order type that this order type is associated with.

hours

object

The hours this order type is available (if they differ from normal merchant hours)