Create a modifier group

post

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mId

string

required

Merchant identifier (mId).

Query Params

expand

string

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

Body Params

string

Unique identifier of the modifier group.

name

string

required

Name of the modifier group.

alternateName

string

Alternate name of the modifier group.

minRequired

integer

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

maxAllowed

integer

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

showByDefault

boolean

Defaults to true

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

modifiers

array of objects

modifiers

modifierIds

string

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

items

array of objects

items

sortOrder

integer

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

Headers

User-Agent

string

required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

200

Successful response. Modifier group is created.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here!