Add a new ModifierClass

post

https://qa2.revelup.com/resources/ModifierClass/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

ModifierClass object that needs to be added.

active

boolean

Defaults to true

admin_mod_key

string

length ≤ 10

Internal code used for defining is modifier admin modifier. If applied, it will force rules for that modifier, and will work if admin_modifier is set to true.

admin_modifier

boolean

Defaults to false

If true it means that this is one of 5 basic modifiers that are set up.

color_code

integer

enum

Color you would like to be displayed for this modifier on POS.

Color Codes:

0 - COLOR_CODE_NONE
1 - COLOR_CODE_BLUE
2 - COLOR_CODE_BROWN
3 - COLOR_CODE_DARKPURPLE
4 - COLOR_CODE_FUCHSIA
5 - COLOR_CODE_GREEN
6 - COLOR_CODE_PALEGREEN
7 - COLOR_CODE_PURPLE
8 - COLOR_CODE_RED
9 - COLOR_CODE_TAN
10 - COLOR_CODE_TEAL
11 - COLOR_CODE_ORANGE

created_by

uri

required

URI of the User that created this object.

created_date

date-time

Date and time when object was created.

establishment

int64

required

URI of the establishment where this object was created.

free_modifier

int64

required

≥ 0

Number of modifiers of this class that are free.

lock_add_modifier

integer

enum

'Lock adding' will prevent adding from the same location, 'Lock all adding' will prevent adding from all locations.

Lock Type.

0 - Unlock adding
1 - Lock adding
2 - Lock all adding

Allowed:

name

string

required

length ≤ 80

Name of the Modifier object.

sort

int64

required

≥ 0

Numerical value that represents the sorting order for the resources displayed in the UI. Lower values appear higher on the list.

split

boolean

Defaults to false

If checked, any modifier assigned to this class are eligible to be split(by global setting). If uncheked, this class of modifiers will not be split-eligable.

updated_by

integer

required

URI of the User that created this object.

updated_date

date-time

Date and time when object was last updated.

Responses

201

Successful operation

400

Bad request

401

Authorization required