Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
INVENTORY

Create a modifier group

Creates a new modifier group. After you create a modifier group, you can associate modifiers with the group.

post/v3/merchants/{mId}/modifier_groups

Path parameters

mIdstring required

Merchant identifier (mId).

Query parameters

expandstring

Expandable fields to display additional nested information: [modifiers, items].

Headers

User-Agentstring required

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

Request body

idstring

Unique identifier of the modifier group.

namestring required

Name of the modifier group.

alternateNamestring

Alternate name of the modifier group.

minRequiredinteger

Minimum number of modifiers from this group that must be applied to associated lineItems when using the Register merchant plan.

maxAllowedinteger

Maximum number modifiers from this group that can be applied to associated lineItems when using the Register merchant plan.

showByDefaultboolean

Indicates whether employees receive an automatic message to add modifiers from this group when using the Register merchant plan.

modifierIdsstring

Unique identifiers of the modifiers in a group. Displays as a read-only, sorted, comma-separated list.

sortOrderinteger

Sorted list (ascending or descending) that indicates the ranking of the modifier group as compared to other modifier groups.

Response

Successful response. Modifier group is created.