Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
INVENTORY

Get a modifier group

Get a single modifier group by it's UUID

get/v3/merchants/{mId}/modifier_groups/{modGroupId}

Path parameters

mIdstring required

Merchant Id

modGroupIdstring required

Modifier Group Id

Query parameters

expandstring

Expandable fields: [modifiers, items]

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

idstring

Unique identifier

namestring

Name of the modifier group

alternateNamestring
minRequiredinteger

The minimum amount of modifiers from this group that must be applied to associated lineItems when using Register

maxAllowedinteger

The maximum amount of modifiers from this group that can be applied to associated lineItems when using Register

showByDefaultboolean

Whether employees will be automatically prompted to add modifiers from this category when using Register

modifierIdsstring

An ordered, comma-separated list of modifier ids in this group. (READ ONLY)

sortOrderinteger

The ordinal value used to determine where in an ordered list this modifier group should appear relative to others.