GuidesDiscussionsAPI ReferenceChangelogMy Application
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesDiscussionsAPI ReferenceChangelogMy ApplicationLog In
API Reference

Overwrite an existing Modifier

put
https://qa2.revelup.com/resources/Modifier//

Overwrites a specific Modifier API object

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

ID of Modifier to update

Body Params

new Modifier object

boolean
Defaults to true

Flag. If set to True, the modifier is visible and can be used in product sales.

string

Alphanumeric barcode - can be used to find modifiers quickly. Must be unique in a given Establishment and can not exceed 200 characters.

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
string

Inventory cost of the modifier. Up to 4 decimal places supported. Maximum length is 16 characters.

uri
required

URI of the User API object that created this resource.

date-time
required

ISO8601 timestamp of the time the resource was created

boolean
Defaults to false

Flag. If set to True, the modifier is completely hidden from the POS and the Management Console UI.

string

Additional information about the modifier. Free text field.

boolean
Defaults to true

Flag. If set to True, the modifier will be available on Kiosk type POS stations.

boolean
Defaults to false

Flag. If set to True, the modifier will not be printed on kitchen and recipe printers.

uri

URI of an Establishment API object which is related to the modifier

boolean
Defaults to false

Flag. If set to True, when attached to a product with "is_cold": true, will cause it to become taxed. Relevant for California tax rules.

boolean
Defaults to false

Flag. If set to True, the modifier will become available for all products and will appear on the first page of available selections.

string

Use this field for additional details, such as recipe information, to assist employees in preparing items in the kitchen. The data in the field shall display in the product details on the KDS.

string

Name to be used on all kitchen receipts and KDS screens instead of the modifier name. Maximum length is 200 characters.

uri
required

URI of the ModifierClass API object that this modifier is attached to. Multiple Modifier resources may be attached to a single ModifierClass.

string
required

Name of the modifier. Can not be greater than 80 characters in length.

boolean
Defaults to false

Flag. If set to True, allows default modifiers to be de-selected. Ignored if the "Modifier Substitutions" system setting is disabled.

boolean
Defaults to false

Flag. If set to True, the modifier inventory quantity can be increased through the Inventory page by consuming products/ingredients specified in the modifier recipe. See the linked ModifierRecipe API objects for a list of consumed items.

string

Prep recipe efficiency. Specifies how much the inventory quantity is increased per use of the prep recipe feature. Value must be greater than zero and can not exceed 16 characters. Up to 4 decimal places supported.

float
required

Price of the modifier. Stores up to 14 decimal places.

string

Modifier SKU - can be used to find modifiers quickly. Must be unique in a given Establishment and can not exceed 200 characters. Allows letters, numbers, underscores, dots, dashes and commas.

int64
required

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

substitutions
array of strings

Array of Modifier API object URIs. Specifies modifiers that can be used as alternatives to this modifier. Only applicable to ProductModifier API objects where the "default_modifier" field is set to true.

substitutions
uri
required

URI of the User API object that last made changes to this resource.

date-time
required

ISO8601 timestamp of the last time the resource was updated.

Responses
204

Resource successfully updated.

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

Provided JSON body is either invalid or empty.

404

Modifier with the provided ID not found.

Updated over 2 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated over 2 years ago