v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

INVENTORY

Get all modifier groups

Retrieves all modifier groups. Modifier groupings are the categories to which different modifiers belong. Modifier groups can be made available for specific inventory Items by creating an item to a modifier group association.

get/v3/merchants/{mId}/modifier_groups

Path parameters

mIdstring required

Merchant identifier (mId).

Query parameters

filterstring

Filter fields to display search results: [modifiedTime, category.id, negativeSortOrder, item.id, sortOrder, name, id, showByDefault]

expandstring

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

offsetinteger

Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

limitinteger

Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000

Headers

User-Agentstring required

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

Response

Successful response. Displays all modifier groups.

idstring

Unique identifier of the modifier group.

namestring

Modifier group name.

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 app.

maxAllowedinteger

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

showByDefaultboolean

Indicates whether employees are automatically prompted to add modifiers from this category when using the Register app.

modifierIdsstring

Read-only. Comma-separated list of sorted modifier IDs in the modifier group.

sortOrderinteger

Sort order of the modifier group.